Изменения кода, цель задачи, соглашения проекта и результаты доступных тестов.
Замечания по значимости с местами в коде, последствиями и вариантами исправления; вывод о готовности к слиянию.
Кому пригодится
Разработчикам и руководителям инженерных команд.
Требования и ограничения
Последовательная проверка изменения кода
Скилл организует ревью pull request в несколько отдельных проходов. Он предназначен для разработчика или команды, которым нужен понятный вывод о готовности изменения к слиянию. Основной материал — diff, описание ожидаемого поведения и сведения о том, как изменение попадёт к пользователям. Окружающий код читается там, где он нужен для понимания последствий.
Корректность и устройство решения
Сначала сопоставляются заявленная задача и фактическое поведение. Особое внимание уделяется пустым значениям, границам диапазонов, Unicode, большим объёмам, параллельному выполнению и ошибкам, которые код молча подавляет. Отдельно рассматриваются неожиданные изменения общего состояния.
Следующий проход посвящён именам, соответствию принятым в проекте подходам, лишним абстракциям и повторяющемуся коду. Посторонние изменения и новый публичный интерфейс требуют отдельного внимания: они увеличивают объём обсуждения и усложняют последующие исправления.
Безопасность и нагрузка
Входные данные прослеживаются до запросов, команд оболочки, файловых путей и HTML. Проверяется наличие авторизации, отсутствие секретов в коде и чувствительных данных в журналах. Если изменение затрагивает аутентификацию, криптографию или деньги, автор предлагает дополнить обычное ревью специализированной проверкой безопасности.
В проходе по производительности рассматриваются запросы N+1, ввод-вывод в цикле, неограниченные выборки и отсутствие пагинации. Замечание должно объяснять влияние на ожидаемый объём работы; улучшение редкого участка на доли времени само по себе не делает исправление обязательным.
Тесты на поведение
Проверяется, охватывают ли тесты новый сценарий и его ошибки. Для исправленного дефекта полезен тест, который воспроизводит сбой до изменения. Реальные часы, задержки, общий изменяемый контекст и зависимость от порядка запуска рассматриваются как источники нестабильности. Тесты должны подтверждать пользовательское поведение, а не закреплять внутреннее устройство реализации.
Отчёт с адресными замечаниями
Итог содержит решение о слиянии и замечания по значимости: блокирующие дефекты, желательные исправления и мелкие стилистические предложения. В каждом пункте указываются место, конкретное последствие и возможное исправление. Отдельно перечисляются выполненные проходы и пропуски. Такой формат позволяет автору понять причину требования, исправить проблему и отличить риск для продукта от личного предпочтения рецензента.
Автор и источник
Оригинальное название: code-review-checklist
Автор или репозиторий: SkillMedev/skills
Лицензия: MIT
Открыть первоисточник