31/01/2022
Ключевые правила успешного ревью кода
Ревью кода — связующее звено во взаимодействии любой эффективной команды разработчиков ПО.
1. Всегда делитесь своими мыслями
Как бы очевидно это ни звучало, участие в ревью требует критического отношения к собственным размышлениям. Если вы новичок в этом деле или не понимаете внутренней работы кода, стоит озвучивать неясные для вас моменты.
Даже старшие разработчики периодически обращаются за разъяснениями. Решением может оказаться как простое добавление комментария для операций над байтами, так и полный рефакторинг алгоритма.
2. Вникайте в критерии приемки
Данное правило подразумевает, что, во-первых, вы знаете цель и задачи запроса на слияние, а во-вторых, понимаете, насколько выполненные изменения способствуют их реализации. Что касается критерием приемки, то здесь главное — детализация каждого уровня абстракции.
Для понимания этих критериев сначала следует просмотреть тикет, связанный с запросом на слияние. Он должен содержать описание общих целей и деталей реализации.
3. Вносите только небольшие изменения
Запрос на слияние в размере 1,000+ строк ничего, кроме уныния, не вызывает. Скорее всего, никто не будет просматривать такой большой объем кода. В идеале запрос должен включать от 10 до 100 строк.
Сначала это может звучать пугающе, но существуют практические шаги для сокращения процесса ревью. Убедитесь, что файл .gitignore в порядке. Именно он указывает системе контроля версий Git на файлы, которые должны игнорироваться.
4. Соблюдайте баланс
Ревью кода — процесс не из легких. Нужно быть обстоятельным в ответах, но при этом не спамить коллег сообщениями, а также уважительным, но правдивым. Более того, необходимо самому проявлять инициативу, не ограничиваясь только предоставлением обратной связи. При ревью кода важно соблюдение баланса, поскольку кто-то любит общаться, а кто-то — нет.