11 подписчиков
Code Review [Часть 1 - Зачем?]
Сегодня начинаю писать статью про код-ревью, выйдет в несколько частей. Больше реакций и обратной связи → быстрее выйдет следующая часть
Код ревью можно воспринимать по-разному, но если относится к нему неправильно, то оно может стать тратой времени и причиной обид и недопониманий, а если корректно, то путем для обмена опыта и надежности кодовой базы и продукта в целом.
Начнем с того, что код ревью может дать вашей команде.
Улучшение качества кода
Code Review — это последняя линия обороны перед тем, как код попадет в продакшен или как минимум в дев ветку. Ведь никто не застрахован от ошибок или ошибок невнимательности.
Опытный ревьюер может заметить:
- Потенциальные баги и кейсы, которые автор мог пропустить
- Проблемы производительности, например, неоптимальные запросы к базе данных или избыточные вычисления
- Проблемы безопасности, такие как незащищенные эндпоинты или некорректные права доступа
- Нарушения архитектурных подходов проекта
- Неправильно реализованная задача
Примеров из практики может быть просто бесконечно много - забытые тесты, написание бизнес-логики на уровне представления (View), ошибка в логике, упущенные требования из задачи
Распространение знаний в команде
Code Review — это не просто проверка кода, но это еще и процесс обмена знаниями:
- Новые члены команды учатся лучшим практикам и подходам конкретного проекта
- Знания о различных частях системы распространяются между разработчиками
- Повышение вовлеченности в задачи других людей и понимания проекта
Улучшение документации и тестирования
Процесс ревью естественным образом подталкивает к:
- Написанию более понятных комментариев и документации
- Улучшению покрытия тестами
- Созданию более говорящих названий переменных и функций
- Добавлению примеров использования кода
Когда ты понимаешь, что на твой код будет кто-то смотреть, то невольно начинаешь писать его более понятным, красивым и поддерживаемым.
Польза для “бизнеса”
Хотя Code Review требует времени, его преимущества перевешивают затраты:
- Уменьшение количества багов в продакшене (по статистике Google, правильно организованный процесс ревью уменьшает количество багов на 60-90%)
- Ускорение онбординга новых разработчиков
- Повышение качества и поддерживаемости кода
- Уменьшение затрат на исправление ошибок в долгосрочной перспективе
Важно понимать, что Code Review — это не инструмент контроля или критики, а способ сделать код и команду лучше. При правильной организации процесса разработчики начинают воспринимать ревью как возможность учиться и делиться знаниями, а не как формальную процедуру или критику их работы.
В следующей части мы поговорим о том, как подготовить МР к код ревью
2 минуты
25 декабря 2024