Открытие и описание PR
Вы написали изменение, прогнали тесты, и diff выглядит чисто. Теперь нужно открыть PR — но однострочный заголовок вроде "fix bug" не даёт рецензенту ничего, от чего можно оттолкнуться. Хорошее описание PR не повторяет то, что diff и так показывает — оно объясняет зачем: что вызвало изменение, как пр
Хорошее описание похоже на записку, которую оставляют няне: написать 'присмотри за ребёнком' недостаточно — нужно объяснить, почему сегодняшний распорядок отличается и как проверить, что всё в порядке перед сном.
- Описание PR
- Текст, сопровождающий Pull Request, который объясняет рецензенту, почему было сделано изменение, как его протестировать и в чём риск — а не просто пересказ того, что diff и так показывает.
- Шаблон PR
- Постоянный файл в репозитории (например, .github/pull_request_template.md), который задаёт, какие разделы должны присутствовать в каждом описании PR, чтобы все заполняли одну и ту же информацию.
- черновой PR (draft PR)
- PR, открытый в состоянии черновика (draft) — виден команде и запускает проверки, но не сигнализирует 'готов к полному ревью', пока не помечен как Ready for review.
- готов к ревью (Ready for review)
- Действие, которое переводит черновой PR в состояние, активно запрашивающее полное внимание рецензента — сигнал, что работа готова, а не просто видима.