Pull request: описание, review и маленькие изменения

Pull request - это предложение влить изменения из одной ветки в другую. В учебном проекте PR помогает привыкнуть к профессиональному процессу: задача, ветка, коммиты, описание,…

Pull request - это предложение влить изменения из одной ветки в другую. В учебном проекте PR помогает привыкнуть к профессиональному процессу: задача, ветка, коммиты, описание, проверка, обсуждение и merge.

PR нужен не только для командной работы. Даже если вы работаете один, он дисциплинирует: заставляет посмотреть на diff целиком и объяснить, зачем сделаны изменения.

Что должно быть в описании

Хорошее описание отвечает на три вопроса:

  1. Что изменилось?
  2. Почему это нужно?
  3. Как проверялось?

Пример:

## Что изменено
- Добавлен раздел FAQ в README.
- Исправлены команды локального запуска.

## Проверка
- Открыл README локально.
- Сверил команды установки зависимостей.

Размер PR

Маленький pull request легче проверить. Если в PR одновременно новая функция, форматирование, переименование файлов и правка документации, review становится тяжелым. Лучше разделить работу на несколько логических шагов.

Review

Review - это проверка решения, а не оценка личности. Комментарии к коду должны быть конкретными: где проблема, почему это риск, как можно исправить. Автор PR должен отвечать по существу и вносить правки отдельными коммитами или обновлением ветки.

Перед отправкой

git status --short
git diff main...HEAD
git log --oneline main..HEAD

Так вы увидите, какие изменения и коммиты попадут в PR. Это снижает шанс случайно отправить мусор или незавершенный эксперимент.

Источники