В каждом жизненном цикле разработки программного обеспечения проверка кода остается одним из ключевых шагов в создании успешного и качественного продукта.
В большинстве случаев проверка кода - это момент "Сделай это или сломай".
Проверку кода, которой часто пренебрегают, часто недооценивают, иногда пропускают по обманчивым причинам.
Сегодня мы собираемся перечислить 6 лучших советов по проведению успешной и плодотворной проверки кода.
I - Выберите подходящий момент
Успешная проверка кода начинается с выбора подходящего момента для ее выполнения.
Какой подходящий момент для выполнения проверки кода?
Хороший момент обладает следующими характеристиками:
- Низкая вероятность того, что вас прервут: вам следует избегать того времени дня, когда вы по опыту знаете, что люди склонны прерывать вашу работу. В дни часто бывают более спокойные периоды, и именно здесь вам следует проводить обзор кода.
- Правильное настроение: вы не испытывали стресса десять минут назад и не боялись важной встречи час спустя. И рецензент, и рецензент должны быть в хорошем настроении, чтобы гарантировать, что никакие потрясения не испортят ревью кода.
- Проверяющий гарантирует, что код готов к проверке: действительно нет смысла тратить время на проверку кода, который не готов. Под готовностью подразумевается, что код должен быть как минимум качественным, прокомментированным и протестированным. Если рецензент выделяет время на рецензирование какого-либо кода, на самом деле ничего не стоит делать с готовой статьей.
II - Установите границы проверки кода
Перед тем, как начать проверку кода, вы должны установить для него правильные и достижимые границы. Это означает, что вы должны знать, что именно вы собираетесь освещать, заранее.
Мы собираемся рассмотреть одну или несколько функций?
Имеет ли смысл проверять слишком много функций, учитывая время, отведенное на предыдущем этапе?
Проверка кода может состоять из интеграции нескольких небольших функций или нескольких крупных.
Во многих случаях вы хотите сосредоточиться на нескольких функциях, чтобы точно понимать, что они собой представляют, и не слишком часто переключаться с одной функции на другую.
Чтобы установить границы, вы можете:
- Имейте хорошо написанные задачи с правильным размером в системе управления тикетами, такой как Jira, или даже, например, на классической доске.
- Правильно расставьте приоритеты при проверке кода: некоторые задачи могут быть более срочными, чем другие. Если необходимо интегрировать слишком много задач, вы не сможете выполнить их все. Выбирай с умом.
III - Установите для него подходящую среду
Это очень важный момент.
Перед тем, как начать любую проверку кода, вы хотите установить правильную среду для проверки кода.
Каковы характеристики правильной среды?
- В вашей среде должно быть тихо: проверка кода не может выполняться эффективно, когда вокруг вас много шума. Хорошая концентрация важна для того, чтобы эффективно выполнять задачу, которую вы должны выполнить.
- Зона отсутствия прерывания: аналогично тому, что мы описали в первой части, вы можете захотеть находиться в комнате с ограниченным доступом, поскольку вы не хотите, чтобы вас беспокоили во время процесса. .
- Зона позитивного христианства: критиковать чью-то работу - тяжелый процесс. Но это сложно даже, когда вокруг тебя много людей. В комнате с ограниченным доступом вы можете свободно высказывать свои комментарии, не опасаясь, что кто-то их выслушает.
IV - Общайтесь, общайтесь, общайтесь
Я действительно хотел сделать акцент на этом моменте.
Проверка кода - это не односторонний процесс, а как раз наоборот.
Успешная проверка кода во многом зависит от способности уважительно и эффективно общаться с коллегами.
Проверка кода заключается не только в том, чтобы проверяемый выражал свои намерения. Речь идет не только о том, чтобы рецензент указывал, что правильно, а что нет.
Это действительно должен быть разговор обо всем, что его составляет: масштаб, намерение, исправления и даже разногласия.
Вот ключевые моменты для успешного общения:
- Не просто слушайте, слушайте: проверка кода должна быть моментом понимания и проницательности. Вы не можете слушать звук собственного голоса. Мнения и взгляды могут отличаться, и каждое разногласие должно приводить к конструктивному обсуждению проблемы.
- Нейтральный тон: проверка кода - это не экзамен на доске и не инквизиция. Должно быть ощущение, что оценивают код, а не разработчика, стоящего за ним.
- Если сомневаетесь, спросите: если вы не уверены в какой-либо конкретной детали при проверке кода, спросите об этом. Некоторые намерения не проясняются с самого начала и могут привести к неправильному толкованию.
V - Помните о результатах
Проверка кода всегда приводит к результату: это может быть встречная проверка представленного кода или интеграция кода с соответствующими ветвями, которые вы выбрали для своего gitflow.
Здесь ответственность рецензента. Рецензент несет ответственность за представление хорошего кода рецензенту, но окончательное решение остается за рецензентом.
Как понять, можно ли интегрировать код?
Вот несколько критериев, которые помогут вам принять решение:
- Написанный код и выполненная разработка релевантны тому, о чем просили в соответствующем тикете.
- Код правильно прошел модульное тестирование и «считается безопасным» для основных веток.
- Никаких явных запахов кода или недобросовестных действий.
VI - Используйте специальные инструменты
Существуют инструменты для выполнения надлежащей проверки кода, и вы должны без колебаний использовать их, чтобы упростить процесс интеграции.
Когда дело доходит до программного обеспечения для проверки кода, преобладают три бренда: Smartbear (с Collaborator), Perforce (с Helix Swarm) и Atlassian (с Crucible).
Такие инструменты часто предоставляют полный интерфейс для организации обзоров кода, а также метрики для постоянного улучшения вашей команды.
Это больше, чем инструмент сравнения кода, и он интегрируется практически со всеми доступными системами контроля версий.
Попробуйте!
X - Ваша очередь делиться!
Эти советы помогли вам организовать проверку кода?
Имеет ли теперь смысл ваша роль в обзоре кода?
Если у вас есть дополнительные советы или конкретные примеры, которые случались с вами в повседневной жизни разработчика, обязательно поделитесь ими, оставив комментарий ниже.
Это действительно помогает новым разработчикам.
Не стесняйтесь поделиться другими нашими статьями по продуктивности и нашей последней статьей о завершении побочного проекта.
А пока развлекайтесь, как всегда.
Первоначально опубликовано на http://devconnected.com 1 мая 2019 г.