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

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

Надо знать

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

  • Рабочая ветка — мастер , и все PR должны быть сделаны против мастера.
  • Запустите npm install на корневом уровне блочных образцов, а не на уровне отдельного плагина. 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 на корневом уровне блочных образцов, чтобы установить зависимости.
  2. Запустите npm run start в каталоге плагина, чтобы создать и запустить сервер, на котором работает тестовая страница плагина. Вы можете использовать эту страницу, чтобы увидеть существующее поведение плагина, или, если вы добавляете новый плагин, вам нужно будет сделать это полезной тестовой страницей, чтобы другие могли видеть, что делает ваш плагин. Дополнительную информацию смотрите на странице детской площадки .
  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 против мастера со своими изменениями.