Code review Ревью (инспекция) кода - одна из самых распростр | Mobile Pet

Code review

Ревью (инспекция) кода - одна из самых распространенных и полезных практик командной разработки. Основные цели практики – улучшение качества продукта и обмен знаний между участниками.

Суть практики в цикличной проверке кода: автор пишет код предоставляет его проверяющему(-щим) тот смотрит и принимает решение о слиянии кода. Если в коде есть ошибки, автор должен их исправить, после чего цикл повторится. Если код достаточно хорош для слияния, ревью считается завершенным. Очень похоже на циклическую проверку домашки учителем, в результате которой ученик обязан получить 5.

В современном мире code review осуществляется с помощью git и запросов на слияние (pull requests). Многие git-хостинги (GitHub, GitLab, Bitbucket) предоставляют удобный интерфейс для проверки, комментирования и отслеживания статуса процесса.

Вот несколько полезных советов касаемо code review для проверяющих:

при проверке опирайтесь на требования к коду, принятые в вашей команде, если их нет – постепенно начните формировать в отдельном разделе базы знаний
экономьте время с помощью автоматизации: настройте скрипт, который запустится при создании PR-а и выполнит spell-checker, статический анализ, тесты и сборку перед тем, как вы сядете за проверку
старайтесь не откладывать проверку: сделайте ее как можно раньше, чтобы не тормозить процесс
вежливо и обоснованно формулируйте требования к коду автора, приводите примеры желаемого кода там, где это необходимо
не пропускайте сомнительные места: запустите обсуждение в комментариях и совместно решите, нужно здесь что-то править или нет

И для автора:

сформируйте список изменений, которые отправляются на проверку, и прикрепите его к PR-у
следите за объемом кода, входящего в PR: оптимальные значения: 200-500 строк
соблюдайте требования к коду, принятые в вашей команде
старайтесь не повторять ошибки от PR-а к PR-у, в ваших силах не наступать на одни грабли дважды
не стесняйтесь высказать свое мнение или задать вопрос в комментариях к PR-у, в этом суть code review

#development #management