Введение
Для чего нужен git, как работать с состоянием файлом разобрались из части Архитектурного курса Development.
Маленькая справка о том, что такое pull request.
Pull Request (далее PR) — это запрос на включение сделанных вами изменений. Официальная GitHub дока по Pull Requests.
Его нужно хорошо и подробно оформить, чтобы другой разработчик мог быстро понять и принять ваши изменения. Мы разберем N правил оформления pull request, которых вам нужно придерживаться.
Правило 1. Хорошее название PR
Каждый PR должен иметь название, отражающее суть сделанного изменения. Например, если вы добавляете новый класс, то название запроса должно быть вида “Добавление класса Name”.
Если вы добавляете новый метод в класс, то название запроса должно быть вида “Добавление метода Name в класс Name “.
Кроме этого, в названии PR должен быть указан номер задачи: из JIRA, из GitHub issues, или из вашего лога. Если у задачи нет номера - просто пишем NO-TASK.
С названием разобрались, идеальное название PR на картинке.
Правило 2. Подробное описание PR
Каждый PR должен иметь максимально подробное описание, с отражением сути изменений, скриншотами сделанного, номером закрываемой задачи, чекбоксы, чтобы Ревьевер мог понять, что сделано и какие задачи стоят дальше.
Можно заготовить специальный pull request template, в котором будут отражены поля, которые разработчик должен заполнить.
В GitHub Docs есть инструкция как это сделать.
Правило 3. Правильные коммиты отразят изменения даже лучше, чем описание PR
Тому как писать коммиты можно посвятить отдельную статью в курсе, но кратко описать всё же стоит.
Правила писания коммитов рознятся от команды в команду, но определенные правила есть.
- Коммит должен отражать основную суть задачи, но не должен быть длинным. (не более 70 символов).
Коммит вида: “fix: fix code-review” не подходит.
2. Коммит должен иметь заголовок вида “feat: add new method”. Подробнее о заголовках можно будет прочитать в курсе или ознакомиться в этой статье.
3. Коммит должен быть в повелительном наклонении.
Хорошим решением будет установить commit-linter.
Заключение
Хорошо оформленный PR ускорит процесс проверки и принятия изменений, облегчит жизнь другим разработчикам, а также поможет в понимании какие изменения нужно принять.
Скрины, подробное описание, видео помогут быстрее погрузится в контекст задачи, Коммиты подробно отобразят изменения в коде, Название PR будет показывать номер сделанной задачи
