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

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

Надо знать

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

  • Рабочая ветка - это разработка и все PR должны быть сделаны против разработки.
  • Вы должны заполнить шаблон запроса на включение запрошенной информацией.
  • Код должен соответствовать Руководству по стилю 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 tests/mocha , но мы можем попросить вас предоставить другие типы тестов.
  7. Запустите npm run format , чтобы отформатировать код и автоматически исправить некоторые проблемы с ворсом.
  8. Запустите npm test , чтобы запустить автоматические тесты. Это также запускает eslint .
  9. Если есть ошибки lint, запустите npm run lint:fix , чтобы исправить проблемы, которые можно исправить автоматически. Устраните все оставшиеся предупреждения или ошибки lint.
  10. Если все тесты пройдены, вы готовы открыть PR на разработку с вашими изменениями.