Евгений Зайферт, бэкенд-разработчик из Москвы, шесть лет работает с Python и Go и регулярно участвует в код-ревью — проверке кода коллег перед тем, как изменения попадут в рабочую систему. Для начинающих разработчиков ревью часто становится стрессом: кажется, что каждое замечание — это оценка тебя, а не кода. В этой колонке Евгений рассказывает, как сделать ревью полезным для всех.
Евгений Зайферт: зачем вообще нужно код-ревью
Код-ревью — это не экзамен и не проверка на профпригодность. Это способ найти ошибки до того, как их найдут пользователи, и сделать так, чтобы код понимал не только автор.
По словам Евгения, код — лишь часть работы программиста. Остальное — коммуникация и инженерные решения. Ревью — одно из мест, где эта коммуникация происходит каждый день.
1. Присылайте небольшие изменения
Чем больше изменение, тем хуже его проверяют. Изменение на 50 строк коллега прочитает внимательно. Изменение на 2000 строк он, скорее всего, просмотрит по диагонали.
Если задача большая, разбейте её на несколько независимых частей и отправляйте на ревью по очереди.
2. Пишите понятное описание
В описании изменения коротко ответьте на три вопроса:
- что сделано;
- зачем это нужно — ссылка на задачу или пару предложений о проблеме;
- как проверить — что запустить или куда посмотреть.
Хорошее описание экономит время проверяющего и снижает количество вопросов.
3. Проверьте себя сами
Перед отправкой посмотрите на свои изменения так, как будто их написал кто-то другой. Удалите отладочный вывод, закомментированный код, случайные изменения в других файлах. Запустите тесты.
Многие замечания на ревью — это то, что автор мог бы заметить сам за пять минут.
4. Замечание — о коде, а не о вас
Это самое важное правило. Когда коллега пишет «здесь лучше вынести логику в отдельную функцию», он говорит о коде, а не о вашем уровне.
Если замечание непонятно — спросите. Если вы не согласны — объясните свою логику. Спокойная дискуссия на ревью часто приводит к лучшему решению, чем было у обоих участников.
5. Не бойтесь задавать вопросы
Совет, который Евгений дал бы себе в начале пути: не бояться задавать вопросы и читать чужой код. На ревью это работает в обе стороны. Если вы проверяете чужой код и что-то не понимаете, вопрос «почему здесь так?» — полезное замечание, а не признак слабости.
6. Проверяйте чужой код — это лучшая тренировка
Участвуйте в ревью коллег, даже если вы новичок. Чтение чужих изменений быстро учит понимать, как устроен проект, какие приёмы приняты в команде и где обычно бывают ошибки.
Замечания стоит писать конкретно и по делу:
- плохо: «это непонятно»;
- хорошо: «не понимаю, что вернётся, если список пустой — можно добавить проверку или тест?»
7. Благодарите и закрывайте обсуждения
Когда исправили замечание, коротко ответьте в обсуждении: «исправил» или «оставил так, потому что…». Это помогает проверяющему быстро пройти второй круг. И не забывайте благодарить: ревью — это время коллеги, потраченное на ваш код.
Коротко
- присылайте небольшие изменения
- пишите, что, зачем и как проверить
- проверяйте себя перед отправкой
- воспринимайте замечания как разговор о коде
- задавайте вопросы
- участвуйте в ревью коллег
- отвечайте на замечания и благодарите
Хорошее код-ревью делает сильнее не только код, но и команду. А для начинающего разработчика это один из самых быстрых способов расти.
Обсуждение статьи