Руководство для рецензентов и сопровождающих

Вот несколько рекомендаций для участников, которые предоставляют рецензии на запросы на включение изменений (pull-requests).

1. В каждом отдельном запросе на включение изменений должен быть активен только один рецензент. Когда рецензент закончит работу, другие могут добавить короткие комментарии или дополнительные рецензии по мере необходимости. Опять же, по одному за раз.
2. Следует избегать назначения рецензентов, если только запрос на включение изменений не относится к конкретной задаче, в которой рецензент более опытен.
3. Любой участник, чей код был объединён с репозиторием, может предоставить рецензии, поскольку они хотя бы один раз ознакомились со стандартами репозитория. Рецензент будет работать по принципу «первым пришёл — первым обслужен».
4. Во многих репозиториях есть контрольный список в описании запросов на включение изменений. Часто участники не следуют им и просто удаляют контрольный список или проверяют его, не тратя время на рассмотрение пунктов контрольного списка. Эти участники почти всегда копируют код откуда-то. На это следует вежливо указать, а рецензии следует заблокировать до тех пор, пока участник не обновит базовую структуру кода в соответствии с контрольным списком и стандартами репозитория.
5. Рецензенты должны соответствующим образом маркировать каждый запрос на включение изменений, включая «недействителен», если это так.
6. Некоторые запросы на включение изменений содержат существующий дублированный код или дублированные запросы на включение изменений или иногда новичок может создавать новый запрос на включение изменений для каждого нового коммита. Это сложная задача, но одна из обязанностей рецензента.
7. Не рекомендуется создавать ветки в репозитории, лучше разветвить репозиторий в соответствующем пользовательском пространстве и вносить свой вклад из этой вилки.
8. Некоторые репозитории — C и C++ — сотрудничают с GitPod, где код и вклад можно выполнить и протестировать онлайн с относительной простотой. Он также содержит инструменты, необходимые для выполнения отладки и проверок CI без установки каких-либо инструментов. Поощряйте участников использовать эту функцию. Рецензенты могут тестировать внесённые алгоритмы онлайн, не беспокоясь о вилках и ветках.
9. Не следует торопиться объединять запросы на включение изменений. Поскольку репозитории являются образовательными, лучше получить правильные вклады, даже если на их проверку потребуется немного больше времени. Поощряйте терпение и развивайте навыки отладки у участников.