Code Review: когда контекст спасает нервы (и репутацию)
Google напоминает: «LGTM» без пояснений — путь к ночным багам и пассивной агрессии в пулл-реквестах.
Google в своём блоге для тестировщиков выпустил заметку, которая должна стать настольной для каждого, кто хоть раз писал «Please add tests» без единого намёка на то, какие именно. Речь о том, как добавлять контекст в ответы на code review — и почему это важно.
Почему это больно
Все мы видели комментарии в стиле «Это плохо» или «Переделай». Автор такого сообщения, вероятно, считает себя гуру, но на деле просто создаёт напряжение. Google предлагает простой рецепт: если уж ругаешь код, объясни почему. И не просто «потому что я так сказал», а с отсылкой к лучшим практикам, потенциальным багам или нефункциональным требованиям.
Когда контекст критичен
Особенно важно добавлять контекст в трёх случаях: при обсуждении безопасности (чтобы автор понял риски), при сложных архитектурных решениях (чтобы не переписывать всё через месяц) и при указании на баги (чтобы разработчик мог воспроизвести проблему). И да, «потому что мне так не нравится» — не контекст.
Как это делать правильно
Вместо «Убери этот костыль» напишите: «Этот хак может сломаться при нагрузке >1000 RPS, давай используем кэш с TTL». Вместо «Добавь тесты» — «Покрой кейс с пустым ответом от API, мы уже ловили такой баг на проде». И обязательно указывайте, что уже проверено, а что — лишь гипотеза.
Комментарий студии METABYTE
Мы в METABYTE тоже проходили стадию «LGTM» и «исправь по ощущениям». Теперь у нас в CI висит плагин, который подсвечивает комментарии без контекста — и количество ночных созвонов упало вдвое. Советуем попробовать, даже если ваш код-ревью — это просто галочка в Jira.