Внести вклад в ядро

Основной репозиторий Blockly содержит код, необходимый для запуска любого приложения на основе Blockly.

Необходимо знать

Вот краткий обзор фактов о ядре Blockly, которые вам необходимо знать для создания запроса на слияние (PR).

  • Рабочая ветка является основной , и все запросы на изменение (PR) должны быть оформлены в направлении основной ветки.
  • Необходимо заполнить шаблон запроса на слияние (pull request) запрашиваемой информацией.
  • Код должен соответствовать руководству по стилю TypeScript от Google.
  • Используйте стандартные обозначения коммитов в сообщениях коммитов и заголовках запросов на слияние.
  • Видимые пользователю строки должны находиться в файле /msg/messages.js , чтобы их можно было перевести. Менее 6% населения мира говорят на английском языке как на родном.
  • Текст в блоках, как правило, должен быть написан строчными буквами (точно так же, как ключевые слова в большинстве языков программирования).
  • Сохраняйте обратную совместимость. Существует множество приложений Blockly, не стоит нарушать работу остальных.

  • Все новые файлы кода должны иметь префикс, содержащий лицензию Apache License v2.0:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

Внести и подтвердить изменение

  1. Для установки зависимостей выполните npm install .
  2. Запустите npm run start , чтобы запустить сервер, на котором работает тестовая среда. Вы можете использовать эту страницу для проверки существующего поведения. Дополнительную информацию см. на странице тестовой среды .
  3. Внесите необходимые изменения в код.
  4. Если вы оставили сервер запущенным, обновите страницу, чтобы увидеть изменения. В противном случае перезапустите сервер и убедитесь, что код работает должным образом и в консоли нет ошибок или предупреждений.
  5. Запустите npm run build и убедитесь в отсутствии ошибок сборки.
  6. Напишите автоматизированные тесты. Обычно это будут тесты Mocha в каталоге tests/mocha , но мы можем попросить вас написать и другие типы тестов.
  7. Запустите npm run format , чтобы отформатировать код и автоматически исправить некоторые ошибки линтера.
  8. Запустите npm test для выполнения автоматизированных тестов. Это также запустит eslint .
  9. Если обнаружены ошибки линтинга, запустите npm run lint:fix , чтобы исправить проблемы, которые можно исправить автоматически. Устраните все оставшиеся предупреждения или ошибки линтинга.
  10. Если все тесты пройдут успешно, вы готовы создать запрос на слияние (PR) в основной репозиторий с вашими изменениями.