Как провести код-ревью pull request в GitHub
Блог

Как провести код-ревью pull request в GitHub

1 просмотрОценить статью0 отзывов

Получив pull request на ревью, сначала прочитайте задачу и посмотрите, какие изменения предлагает автор. Затем проверьте diff, оставьте замечания и отправьте итог ревью. На Mentoring.digital показываем этот процесс на учебной правке, которая меняет правила поиска.

Содержание статьи

Что проверить до комментариев

Во вкладке Conversation прочитайте описание pull request и связанной задачи. Уточните, какое поведение должно измениться. Если автор меняет пробелы в начале и конце запроса, стоит узнать, как поиск должен работать с пробелами внутри строки. Ответ подскажет, какие примеры проверить.

Во вкладке Files changed посмотрите, где обрабатывается запрос и какие тесты изменились. Начните с кода, меняющего поведение, затем переходите к тестам. Список коммитов полезен, если нужно понять, почему правка состоит из нескольких шагов.

Как сформулировать замечание к строке

Представьте, что поиск должен принимать запрос с пробелами по краям, но сохранять пробел между словами. В учебном pull request автор удалил из строки все пробелы. В GitHub наведите указатель на строку во вкладке Files changed и нажмите кнопку с плюсом. Комментарий можно написать так:

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

У замечания есть наблюдение, связь с условием и проверка. Если комментариев несколько, выберите Start a review и соберите их перед отправкой. До отправки эти комментарии видите только вы. Если уместна точная замена строки, её можно оформить как предложение в комментарии, чтобы автор мог применить её из интерфейса.

Когда выбирать Comment, Request changes и Approve

  • Comment подходит для вопросов и обратной связи без утверждения изменений. Например, вы хотите уточнить, понадобится ли поддержка ещё одного формата ввода.
  • Request changes показывает, что автору нужно доработать изменение. В учебном примере запросите исправление обработки пробелов и тест на пробел между словами. Блокировка слияния зависит от настроек защиты ветки и полномочий проверяющего.
  • Approve выбирайте, когда замечания, влияющие на результат, закрыты и проверка изменений закончена. Слияние выполняется отдельно и подчиняется правилам репозитория.

Как проверить исправление в том же pull request

Когда автор добавит коммит, откройте исходное обсуждение и посмотрите свежий diff. Если автор объяснил, что теперь обрезает пробелы по краям, убедитесь, что код сохраняет внутренний пробел, а тест действительно проверяет оба случая. Сверьте статус проверок этой версии. Отметьте в обсуждении, какие замечания закрыты, и отправьте итог ревью.

Для упражнения поменяйтесь ролями с коллегой. Один готовит небольшой pull request, второй фиксирует проблему со входными данными и предложенной проверкой, затем читает исправление. Можно попросить наставника по ревью кода проверить ваши комментарии. На курсах по Code Review можно отработать разбор более крупных изменений.

Мнение читателей

Оценки и отзывы о статье

Оставить отзыв

Как вам статья?

Поставьте оценку. При желании добавьте отзыв или вопрос по статье.

Ваша оценка
5 из 5
0 / 3 000

После одобрения имя, оценка и отзыв будут видны другим читателям. Политика конфиденциальности

Отзывы читателей0

Здесь пока нет отзывов. Расскажите, чем вам помогла статья.

Все статьи