Начните вносить свой вклад в Blockly

Blockly — это проект с открытым исходным кодом, который в основном поддерживается небольшой командой. Мы приветствуем вклад разработчиков, не входящих в основную команду; без участия нашего сообщества мы не сможем реализовать все запрошенные функции или исправить все обнаруженные ошибки. В этом разделе представлены общие руководства, которые могут быть полезны, особенно если вы новичок в разработке с открытым исходным кодом.

Для получения информации, специфичной для Blockly, которую следует прочитать перед внесением вклада, см. разделы « Вклад в ядро» и «Вклад в примеры» .

Какой репозиторий?

В репозитории хранятся все файлы для одного проекта. У Blockly два репозитория: blockly core и blockly-samples.

Blockly core — это репозиторий библиотеки Blockly. Используйте этот репозиторий, если хотите внести изменения в основное поведение Blockly таким образом, чтобы они применялись ко всем пользователям библиотеки.

Blockly samples — это репозиторий для примеров, плагинов и практических заданий. Используйте этот репозиторий, если хотите создать или изменить плагин, написать практическое задание или создать или изменить пример.

Шаг за шагом

Вот общие шаги, которые вам необходимо выполнить при каждом внесении изменений.

  1. Установите Git и Node, перейдя по ссылкам в разделе «Инструменты» .
  2. Создайте форк и клонируйте репозиторий. На GitHub есть замечательное руководство по созданию форков репозиториев . Чтобы применить его к Blockly, просто замените каждое вхождение octocat/Spoon-Knife на RaspberryPiFoundation/blockly или RaspberryPiFoundation/blockly-samples , в зависимости от того, с каким репозиторием вы хотите работать.
  3. Синхронизируйте свой форк. GitHub также предоставляет инструкцию по синхронизации форка .
  4. Посмотрите основную ветку. В Blockly Core и Blockly-samples эта ветка называется main .
  5. Установите зависимости и инструменты сборки, выполнив npm install в корневом каталоге.
  6. Создайте новую ветку , выполнив в терминале git checkout -b myBranchName . Название поможет вам запомнить, над чем вы работаете.
  7. Внесите свои изменения.
  8. Проверьте внесенные изменения, следуя инструкциям для ядра или примеров .
  9. Сохраните изменения с помощью git commit -am "fix: My commit message" . Подробнее о сообщениях коммитов можно прочитать здесь .
  10. Отправьте свои изменения в GitHub с помощью git push origin myBranchName .`.
  11. Когда ваш код будет готов, создайте запрос на слияние (pull request) . Член команды Blockly рассмотрит ваши изменения и, в случае одобрения, объединит их с кодом Blockly. Для получения дополнительной информации см. раздел «Процесс рассмотрения запросов на слияние» .