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

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

Нужно знать

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

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

  • Любые новые файлы кода должны иметь префикс 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 для исправления ошибок lint. Устраните все оставшиеся предупреждения или ошибки.
  9. Запустите npm run format , чтобы запустить автоформатер.
  10. Если все тесты пройдены успешно, вы готовы открыть PR для master с вашими изменениями.