Code review, или Как повысить качество кода

Code review — один из важных этапов разработки. Так что же такое code review, какие достоинства и недостатки скрыты под этим процессом? Какие проблемы могут появиться при внедрении code review в проект? Что такое контрпродуктивный code review, почему в ходе него могут возникнуть межличностные конфликты? Какую роль в рефакторинге играет code review? Я расскажу о некоторых тонкостях code review, ошибочных мнениях и решениях, а также поделюсь как негативным, так и позитивным опытом.

Transcript

1. Code Review, или Как повысить качество кода Денис Бубнов
2. Обо мне Software Engineer in Arcadia Опыт разработки с 2014 г. Работаю в Arcadia с 2017 г.
3. Обсуждаемые проблемы • Как отсутствие code review на проекте влияет на разработку • Какие проблемы могут появиться при внедрении code review • Контрпродуктивный code review • Личностные конфликты и code review • Роль code review в рефакторинге
4. Пару слов о code review рецензирование/обзор/инспекция кода во время его разработки
5. Достоинства code review • Обнаружение и исправление ошибок • Стремление писать качественный код • Совершенствование навыков разработчика • Расширение знания кода разработчиками • Решение возникших «проблем» с кодом • Повышение качества кода
6. Недостатки code review • Длительность разработки
7. Отсутствие code review на проекте • Нет никакого контроля над кодом, все пишут так, как хочется • В кодовую базу попадает весь код, даже «код с душком» • Возможность протащить «костыли» или «мамонта»
8. It’s not a bug, it's a feature
9. Что делать, если хочется иметь хороший код и контроль над ним? Внедрить code review на проект или писать код в одиночку.
10. Мы внедрили code review, но ничего не получается Не всегда и не все разработчики правильно понимают, как должен проходить code review.
11. Команда code review • Как разделить права на действия? • Кто может быть рецензентом?
12. Разделение прав на code review • Нельзя явно указать на ошибку (недостаток) в коде • Приходится писать в личку или пользоваться «посредником»
13. Для кого code review? Для автора кода или для рецензента(-ов) кода?
14. Почему code review предназначен для автора? Можно наглядно увидеть внесённые изменения кода.
15. Code review — для всех!
16. Контрпродуктивный code review Автор отказывается вносить правки, а рецензент отказывается утверждать изменения, пока правки не будут внесены.
17. Личностный конфликт, или Почему не стоит писать в комментариях «ты»
18. Оборонительная позиция
19. Количество изменений
20. О чём стоит всегда помнить при написании комментариев? • Комментарий должен быть ориентирован на идее улучшения кода, а не на авторе кода и его ошибках или недочётах • Обозначьте чётко то, что вы имеете в виду • Делитесь примерами кода
21. Что мы делаем не так? Code Review — не про возможность проявить себя и свои знания
22. А что на самом деле? Code review нацелен на совершенствование написания коллективного кода
23. Внедрение Code Review на проект, или О чём ещё нужно договориться • Выделить общепринятые стандарты написания кода • Определиться со стилистическим подходом к написанию кода (вероятно, установить анализатор)
24. Учитесь договариваться и идти на компромиссы
25. Code review не должен быть «токсичным»
26. Роль code review в рефакторинге • Какой набор правил стилей написания кода применить • Согласно каким стандартам написания кода рефакторить Code review поможет вам понять и договориться о том, как должен проходить рефакторинг.
27. Чтобы рефакторинг был немного легче • Покрывайте код тестами • Пишите документацию к коду
28. Заключение • Code review на проекте поможет повысить качество кода • Выделяйте время на командное обсуждение кода • Находите правильные слова для замечаний к коду • Выделяйте время на рефакторинг • Если у вас нет code review — внедряйте • Стремитесь писать качественный код
29. Вопросы и ответы