Код-ревью Pull Request на GitHub
Станьте ревьюером: проверьте код по требованиям во вкладке Files changed, оставьте вежливые комментарии к строкам, запросите исправления и одобрите PR после нового коммита автора.
О продукте
Привет! В прошлый раз ревью проходил твой Pull Request. Сегодня поменяемся ролями: ревьюером будешь ты. Марко из команды разработки открыл PR со скидкой на заказ — его нужно проверить. Но сначала — четыре простых правила для комментариев.
Привет, Кадри! Какое первое правило?
1. Вежливо. Комментарий — про код, а не про автора. Пиши так, как хочется получать самому.
✗ ПлохоОпять ошибка. Ты вообще читал задачу?
✓ ХорошоКажется, здесь не выполняется требование — посмотри, пожалуйста.
А второе?
2. По сути. Комментарий стоит у конкретной строки и говорит, что именно не так. Одна проблема — один комментарий.
✗ ПлохоЗдесь что-то не так.
✓ ХорошоДля заказа ровно на 100 € скидка будет 5 %, а не 10 %.
Этого достаточно?
3. С деталями. Объясни почему: какое требование нарушено и на каком значении ломается. Автору не придётся угадывать.
✗ ПлохоНеправильное условие.
✓ ХорошоПо требованию 10 % — «от 100 €». При total = 100 условие total > 100 ложно.
А последнее?
4. Конструктивно. Предложи решение или задай вопрос. И отметь, что сделано хорошо: ревью помогает автору, а не оценивает его.
✗ ПлохоПеределай.
✓ ХорошоПредлагаю total >= 100. В остальном логика понятная, спасибо!
Запомню! А как проходит само ревью?
Ревьюер читает изменения до того, как они попадут в main, и решает: можно сливать или нужно исправить. Весь путь выглядит так:
- РевьюерFiles changedЧитает изменённые строки и сверяет их с требованиями
- РевьюерКомментарии к строкам«+» у строки → текст → Add single comment
- РевьюерReview changesОбщий отзыв и одно из трёх решений → Submit review
На что смотреть в коде
Делает ли код то, что написано в задаче? Проверь граничные значения — как в тест-дизайне.
Код легко читать: понятные имена, ничего лишнего — ни отладочного вывода, ни закомментированных строк.
Проверим. В коде ошибка: одно требование не выполнено. Какое решение выбрать в Review changes?
Понятно! Открываю PR.
Ревью Pull Request
Шаг 1 · Files changed
Вот PR Марко. На вкладке Conversation — описание: что сделано и какие у задачи требования. Прочитай их: по ним ты будешь проверять код.
Требования понятны. А где сам код?
Открой вкладку Files changed: там видно, какие файлы и строки изменились. Зелёные строки со знаком + — добавленные.
Подсказка
Вкладки PR находятся под заголовком: Conversation · Commits · Files changed.
- Files changed
- Комментарии
- Request changes
- Исправление
- Approve
- Merge
В PR один новый файл src/discount.js: функция получает сумму заказа и возвращает скидку в процентах. Строк немного, но ревьюер читает каждую.
С чего начать проверку?
Шаг 2 · Проверка требований
С требований. Найди в коде условие для каждого из них. Особое внимание — границам 50 € и 100 €: какую скидку вернёт функция, если заказ ровно на 100 €?
Кажется, вижу ошибку! Как оставить комментарий к строке?
Наведи курсор на строку с ошибкой — рядом с номером строки появится синий +. Нажми его, выбери или напиши комментарий и нажми Add single comment.
Подсказка
Требование: «от 100 € — скидка 10 %». Найди строку, где проверяется 100, и подставь total = 100.
Отлично! Условие total > 100 не срабатывает для ровно 100 €, и покупатель получает 5 % вместо 10 %. Хороший комментарий указывает на строку, объясняет проблему и предлагает решение.
Почему ошибка нашлась именно на значении 100?
Больше ошибок нет?
Шаг 3 · Понятность кода
С требованиями разобрались. Теперь прочитай код ещё раз, как будто видишь его впервые: всё ли в нём нужно? Лишние строки мешают читать, а отладочный вывод может показать данные, которые никто не должен видеть.
Вижу лишнюю строку.
Найди строку, которая не нужна для расчёта скидки, и оставь к ней комментарий так же: + → текст → Add single comment.
Подсказка
console.log печатает значения в консоль. Так проверяют код во время разработки, но в готовом коде такой вывод не оставляют.
Да, console.log остался после отладки. Два комментария к строкам готовы — теперь нужно подвести итог ревью.
Как подвести итог?
Шаг 4 · Review changes
Комментарии к строкам — это детали. Итог ревью задаёт кнопка Review changes: в ней пишут общий отзыв и выбирают одно из трёх решений.
Какое решение выбрать?
Нажми Review changes, проверь общий комментарий, выбери подходящее решение и нажми Submit review.
Подсказка
В коде есть ошибка в требованиях → сливать PR пока нельзя. Comment — нейтральный отзыв, Approve — одобрение, Request changes — просьба исправить.
Ревью отправлено: в PR появилась отметка Changes requested, и слияние заблокировано, пока ревьюер не одобрит изменения. Марко получил уведомление и видит твои комментарии.
Ревью помогает автору, а не оценивает его: будь конструктивным и вежливым. Можно отметить и то, что сделано хорошо.
Как Марко должен внести исправления?
Жду исправлений!
Шаг 5 · Повторное ревью
Марко исправил код и сделал push: в PR появился новый коммит. Ревью на этом не заканчивается — нужно убедиться, что исправлено всё, о чём шла речь в комментариях.
Проверяю!
Открой Files changed и проверь обе строки. Если всё в порядке — Review changes → Approve → Submit review.
Подсказка
Условие для 100 € теперь total >= 100, а console.log удалён. Замечаний нет — значит, PR одобряют.
PR одобрен, и Марко слил его в main: изменения стали частью проекта. Сливает PR обычно автор — когда получил Approve и прошли проверки.
Готово!
Отличное ревью! Запомни порядок: Files changed → комментарии к строкам через + → Review changes: Comment, Approve или Request changes → Submit review. Если просишь исправлений, после нового коммита автора посмотри PR ещё раз.
Справка по теме
Files changed
Вкладка PR, где видно, какие файлы и строки изменились: зелёные строки со знаком + добавлены, красные со знаком − удалены. Ревью начинают с неё.
Что проверять
Соответствие требованиям задачи (особенно граничные значения), понятность и читаемость: имена, отсутствие отладочного вывода и лишнего кода.
Комментарий к строке
Наведите курсор на строку — появится синий «+». Нажмите его, напишите комментарий и нажмите Add single comment. Так можно прокомментировать любое количество строк.
Review changes
Итог ревью: общий комментарий и решение. Comment — отзыв без одобрения и блокировки, Approve — можно сливать, Request changes — нужно исправить до слияния. Отправляется кнопкой Submit review.
Тон комментариев
Комментарий — про код, а не про автора. Укажите, что не так, объясните почему и предложите исправление. Вежливость и конкретность экономят время обоим.
После Request changes
Автор исправляет код отдельным коммитом в ту же ветку и делает push — PR обновляется сам. Ревьюер проверяет изменения ещё раз и ставит Approve, после чего PR можно слить (Merge).