Внести вклад в образцы

В репозитории Blockly samples содержится дополнительный контент, связанный с Blockly, который не входит в основной репозиторий, включая плагины, практические задания и примеры кода. Более подробную информацию о каждом из них см. на странице «Структура репозитория» .

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

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

  • Рабочая ветка является основной , и все запросы на изменение (PR) должны быть оформлены в направлении основной ветки.
  • Выполните команду npm install на корневом уровне репозитория `blockly-samples`, а не на уровне отдельного плагина. `blockly-samples` — это монорепозиторий, то есть он содержит несколько пакетов в одном репозитории, и установка на корневом уровне является частью рабочего процесса управления монорепозиторием с помощью Lerna.
  • Код должен соответствовать либо руководству по стилю JavaScript от Google, либо руководству по стилю TypeScript, в зависимости от используемого языка.
  • Используйте стандартные обозначения коммитов в сообщениях коммитов и заголовках запросов на слияние.

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

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

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

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