Как создать правильный код-ревью?

Одним из этапов разработки является код-ревью. С ним ознакамливаются другие специалисты для совершения своей работы. Здесь рассмотрим основные принципы создания правильного кода-ревью.

Автоматическая проверка ошибок. Не стоит надеяться на свой ум и зоркий взгляд. Порой вы будете пропускать ошибки, не замечать их. Чтобы исправить их, воспользуйтесь программами для автоматической проверки. Например, pyflakes, CircleCl, Travis для Python, gofmt, ClangFormat для Go, JSLint для JavaScript.
Не заостряйте внимания на стиле. Для ревью это не слишком важно. Укажите лишь основные пункты, не ставя на них акцента.
Отводите достаточно времени для ревью. Если вам нужно просмотреть работу, то следует это делать внимательно и не торопясь. Помните о том, что вас ждут другие специалисты, их работа остановлена, пока вы не дадите свою оценку коду. Соответственно, сразу принимайтесь за работу, но не торопитесь, а внимательно все вычитывайте.
Помогайте, а не осуждайте. Хорошо, что вы знаете больше, обладаете большим опытом, нежели другие сотрудники, можете их многому научить. Но пока вы сотрудничаете с ними, соблюдайте корректность. Подбирайте слова, объясняйте свои решения, указывайте на ошибки, но без критики. В команде должна быть дружеская атмосфера, а не страх и неуверенность, которая точно не способствует работе.
Укажите на типичные ошибки. Если специалист ошибся в одном месте, он, скорее всего, совершил подобные ошибки во всех аналогичных фрагментах по всему коду. Просмотрите и оставьте в комментариях указания на типичные ошибки.
Приводите примеры для аргументации. Не нужно голословно на что-то указывать другим специалистам. Нужно указывать на примеры и даже давать рекомендации, что можно изменить и почему. Если вы будете говорить так, будто выдаете команды, то никому это не будет интересно.

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

Программирование

другие записи блога