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

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

Проверка кода ссорит команды чаще споров о технологиях, и обычно из-за формы.

Разделяйте уровни: блокирующее замечание и вкусовое, которое стоит помечать как необязательное.

Пишите про код, а не про человека.

Объясняйте причину: замечание без объяснения — приказ, с объяснением — обучение.

Больше десяти правок — зовите на разговор, а не пишите простыню.

Отмечайте хорошее.

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

Разделяйте блокирующее и вкусовое прямо в тексте: «это надо поправить» и «на будущее, необязательно». Без такой пометки автор воспринимает любую придирку к именам как требование.

И помните, что цель проверки — рабочий код в основной ветке, а не идеальный код в вашем представлении.

IT Иркутск — t.me/irkutsk_it