Как писать замечания к чужому коду

Как писать замечания к чужому коду

Ревью ломает отношения в командах чаще, чем любые споры о технологиях. Обычно не из-за содержания замечаний, а из-за формы.

Разделяйте уровни. «Это сломается на пустом списке» — блокирующее. «Здесь можно короче» — вкусовое, и его стоит помечать как необязательное. Когда всё написано одним тоном, автор воспринимает придирку к именам переменных как обвинение.

Пишите про код, а не про человека. «Функция делает три вещи сразу» вместо «ты опять всё смешал». Разница кажется мелкой ровно до того момента, пока замечание не прочитают двадцать человек.

Объясняйте причину. Замечание без объяснения читается как приказ, а с объяснением — как обучение: «давай вынесем в отдельный метод, потому что этот кусок понадобится в отчёте».

Если правок больше десяти — не пишите их в комментариях, позовите на разговор на пятнадцать минут. Так быстрее и без обид.

И отдельно: если код хороший, скажите об этом. Ревью, где встречаются только замечания, довольно быстро начинают ненавидеть все участники.

IT Санкт-Петербург — t.me/itspb_news