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

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

Нужно знать

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

  • Рабочая ветка — develop , и все PR-запросы должны быть сделаны против develop.
  • Вам необходимо заполнить шаблон запроса на извлечение, указав запрашиваемую информацию.
  • Код должен соответствовать руководству по стилю 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. Если есть ошибки lint, запустите npm run lint:fix , чтобы исправить проблемы, которые можно исправить автоматически. Устраните все оставшиеся предупреждения или ошибки lint.
  10. Если все тесты пройдены успешно, вы готовы открыть PR на разработку с вашими изменениями.