Что делать, когда вы устали от медленных обзоров кода

TL;DR

• 🏎 Узнайте, как ускорить процесс проверки кода, чтобы повысить свою продуктивность.
• 🔬 Изучите лучшие практики, с которыми я столкнулся для рецензентов кода.
• ✏️ Ознакомьтесь с лучшими практиками авторов запросов на вытягивание, с которыми я столкнулся.

Представьте это.

Вы только что реализовали функцию и написали все тестовые примеры. Вам понравился код, поэтому вы открыли запрос на извлечение и сообщили своим коллегам. По прошествии нескольких дней ваш запрос на вытягивание выглядел точно так же, как и раньше. С виду нетронутый. Без комментариев. Нет запроса на изменение. Вы снова попросили своих коллег проверить код, и они согласились. Прошла еще неделя, и ничего не произошло. Вы спросили еще раз, и они сказали, что им нужно больше времени, потому что это был не маленький PR, и нужно было многое учесть.

Наконец, вы увидели уведомление о запросе на изменение и сразу ухватились за него. После разрешения конфликтов слияния и исправления пограничных случаев вы снова запросили проверку и стали ждать. Еще один запрос на изменение появился через несколько дней, и вы повторили процесс снова. Вы получили утверждение после очередной проверки, и PR наконец-то был объединен с основной линией.

Через 4 недели с момента открытия PR.

Если вы можете относиться к этому, вы не одиноки. Многие команды столкнулись с таким медленным процессом проверки кода. На самом деле, это один из основных блокировщиков в разработке цикл. Поэтому я хочу поделиться с вами передовыми методами проверки кода, которым я научился, чтобы ускорить разработку и помочь вам быстрее выпускать код.

Поехали.

Для авторов запросов на слияние

Главное, чему я научился, чтобы повысить продуктивность проверки кода, — быть вдумчивым как автор. Помимо создания чистого кода, вы можете сделать много мелких вещей, которые помогут вашим рецензентам заранее понять ваши запросы на вытягивание.

Будьте водителем

Вы, автор, задаете темп. Зная, что вы полагаетесь на своих коллег в процессе проверки кода, вы можете заранее четко сообщить когда и что, чтобы согласовать ожидания.

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

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

• Диаграммы разработки кода: снимок экрана высокоуровневой структуры кода. помогает рецензентам просмотреть общий проектировать и быстро реагировать на ваш запрос на вытягивание.
• Критерии приемлемости: список простых предложений, например . "После отправки формы пользователю отправляется электронное письмо с подтверждением". помогает при проверке найти отсутствующие функции и тестовые примеры.

Будьте лаконичны

Небольшие пулл-реквесты, ориентированные на лазер, легче всего читать. Насколько мал? Инженерные практики Google говорят, что "невозможно сделать его достаточно маленьким" . Исследование показало, что Качество проверки кода снижается по мере увеличения количества изменений кода. Чем дольше ваши рецензенты просматривают за раз, тем меньше дефектов они обнаруживают. Поэтому важно, чтобы ваш запрос на вытягивание был небольшим и был сосредоточен на чем-то одном. Если разрабатываемая вами функция слишком велика, вы можете разделить ее на несколько запросов на вытягивание с помощью "сложенных метод запроса на вытягивание".

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

Для рецензентов кода

Не забывайте о предвзятости

исследование, опубликованное Google в 2022 обнаружил, что авторы пулл-реквестов сталкивались с различными уровнями отказов, которые варьировались в зависимости от демографических данных авторов. Согласно данным, они обнаружил, что