Написание хорошего запроса на включение

Запросы на включение — это кровь репозитория. Они сохраняют все здоровым и подвижным. На этой странице подробно описано, как создать полный и удобный для просмотра PR, что повышает вероятность объединения вашего PR.

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

  1. Общаться
  2. Настроиться
  3. Держите его маленьким
  4. Держи в чистоте
  5. Проверьте свои изменения
  6. Общайтесь (часть 2)

Общаться

Прежде чем приступить к написанию кода, полезно пообщаться с основной командой, чтобы они знали, что вас интересует.

Если вас интересует какая-то проблема, оставьте комментарий к ней и сообщите, что вы собираетесь начать над ней работать. Это гарантирует, что над одной и той же задачей не будут работать несколько человек. Член команды ответит, чтобы подтвердить, что это ваше.

Если у вас есть идея, которая не рассматривается в теме, напишите ее, прежде чем приступить к работе. Это дает команде возможность обсудить, как лучше всего внедрить изменения, прежде чем приступить к их реализации, что в конечном итоге сэкономит вам силы.

Настроиться

Если вы впервые участвуете в Blockly или Blockly-Samples, начните со страницы настройки разработки .

Держите его маленьким

Всегда старайтесь, чтобы ваши изменения были небольшими и целенаправленными. Мы предпочли бы рассмотреть несколько небольших PR, чем рассматривать один гигантский PR. Вот несколько хороших практических правил:

  • Исправьте одну проблему. Не пытайтесь решить несколько проблем одновременно.
  • Ограничьте сферу применения. Обычно PR занимает < 8 часов (в зависимости от вашего знакомства с кодовой базой).
  • Используйте коммиты. Если ваш PR кажется вам слишком большим, разделите изменения на логические группы с помощью git-коммитов.

Держи в чистоте

Зачем заботиться о стиле кода? Мы работаем в долгосрочной перспективе, и последовательный стиль упрощает обслуживание. Стиль относится к тому, как вы называете переменные, а также к тому, как вы структурируете свой код, пишете комментарии и многое другое. Там, где это возможно, мы используем такие инструменты, как eslint, для автоматизации проверок стиля.

В дополнение к eslint следуйте этим руководствам:

Проверьте свои изменения

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

  • Для плагинов : напишите автоматические тесты мокко, охватывающие ваши изменения.
  • Например : вручную протестируйте все продемонстрированные вами функции.
  • Для лабораторий кода : пройдите все руководство в чистой среде и протестируйте любой предоставленный вами пример кода.

Общаться

Это последняя и, пожалуй, самая важная часть создания PR: написание резюме.

Написание отличного PR-отчета поможет другим разработчикам просмотреть ваши изменения, что повысит вероятность того, что они будут приняты быстрее!

Ваше резюме должно включать в себя такие вещи, как:

  • С какой проблемой связан ваш пиар.
  • Какие изменения вносит ваш пиар.
  • Как вы тестировали свои изменения.
  • Все, что вы хотите, чтобы рецензенты тщательно изучили.
  • Любая другая информация, которая, по вашему мнению, необходима рецензентам.

Если вы будете следовать шаблону PR при создании запроса, все будет в порядке. Только не забудьте быть максимально кратким и полным .

Приятного кодирования!