Двухкратный публичный code review, Евгения Фирсова (Яндекс)

Двукратный публичный code review

Евгения Фирсова

Code review на двоих

Польза очевидна:• повышение качества кода;• устранение ошибок;• взаимное обучение;• обмен «тайными знаниями»;• соблюдение code style;• укрепление рабочих связей.

Чего не хватает для счастья?

Резонно хотеть:• автору кода:– как можно больше замечаний по ревью;– взгляд на код с разных сторон;

• команде:– быть в курсе параллельных изменений.

Публичный code review

Если участвует вся команда:

• больше активных участников:– выше качество финального кода;– быстрая/ранняя корректировка;– общая база терминов;– проработанный навык формулирования;

• больше пассивных участников:– обучение на чужих ошибках

(а я так не делаю ли?);– сравнение реализаций

(а я такое же не делаю ли?);– плавное вхождение в новые технологии;– информирование через любопытство.

Процесс публичного code review

разработка подготовказапрос

code review:обсуждение

правки

тестирование

подготовказапрос

code review:обсуждение

правки

релизавтотесты

Запрос на code review

Состав запроса на code review:• тип ревью (промежуточный, финальный);• что сделано

(ссылка на релиз, список задач, описание требований, …);

• где посмотреть(файл c diff’ом, хэш коммита,указание на репозиторий, …);

• на что обратить внимание;• ограничения

(дедлайн на передачу в тестирование,близкий релиз, хот-фикс, …).

Обсуждения в процессе code review

Да:• для автора кода:– отдельный ответ на каждый комментарий;– «исправлено» + хэш коммита;– «не согласен» + аргументация;– «не успеваю» + фиксация задачи;– «спасибо»;

• для ревьюера:– проверка выполненных

по замечаниям правок;– «спасибо».

Нет:• holy war;• переход на личности.

Вхождение в процесс

Этапы для автора кода:1. знакомство с правилами;2. тотальное «да»;3. полноценное участие.

Этапы для ревьюера:4. знакомство с правилами;5. read only;6. «тихий» режим;7. выделенная полуформальная задача,

например:– соблюдение code style;– вычитка комментариев;

8. полноценное участие.

Эффект от публичного code review

В числах:• выложено 39 релизов за квартал;• запрошено 54 code review;• 1..9 ревьюеров (из группы в 9 разработчиков);• получено 405 комментариев;• найдено 8 логических ошибок;• найдено 12 критичных ошибок.

Активность ревьюеров

1 2 3 4 5 6 7 8 90123456789

10

ревьюеры

разы

code review на двоих больше участников

больше замечаний

Уточнения? Вопросы?

[email protected] — задать любые вопросы

www.control-freak.ru — почитать подробнее об управлении версиями, задачами, проблемами и людьми