Золотые правила код-ревью

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

Но, конечно же, из-за сжатых сроков, ожиданий продаж и организационного давления некоторые команды и компании упускают возможности повысить качество кода.

Независимо от того, к какой части спектра ревью кода относится ваша компания, в этой части будет рассказано, как вы можете (и должны) использовать ревью кода, чтобы помочь процессу разработки и другим аспектам культуры организации, и, что наиболее важно, придать большую ценность вашей работе. разработчики

Вот 5 золотых правил код-ревью:

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

Всегда помните - на другом конце обзора находится человек

Первое золотое правило проверки кода простое: просматривайте код других людей так, как будто вы хотите, чтобы просматривали ваш код.

Обзоры кода должны:

• Будьте добры — даже если есть возможности для улучшения, сообщение можно передать с сочувствием

• Будьте ясны — сделайте так, чтобы рецензенту было легко понять, что вы говорите. Важно, если у вас есть конструктивная обратная связь, говорите об этом прямо. Избегайте «дерьмового бутерброда», который начинается с положительных отзывов о коде, даже если он настоящий, прежде чем перейти к вашему предложению по улучшению.

• Будьте конкретным – Чем более подробным может быть ваш отзыв, тем полезнее он будет для Автора.

Это может быть трудно сделать, когда многие из нас работают удаленно или в сотнях или тысячах миль друг от друга.

Чтобы убедиться, что вы правильно общаетесь, прочитайте свой код-ревью про себя вслух и спросите себя, хочу ли я, чтобы это было сказано мне? Если нет, подумайте об изменении тона или содержания.

Дайте четкие предложения или рекомендации

Никогда не говорите кому-либо, что код нужно исправить, не дав советов или рекомендаций о том, что исправить или как это исправить.

Не уверен, почему? Представьте, что кто-то пришел к вам домой и сказал: «Мне не нравится ваш декор. Почини это."

Это невероятно раздражает.

Никогда не рекомендуется писать «Исправить это», не давая дополнительных объяснений. Почему это нужно исправлять? Какие у вас есть предложения, чтобы исправить это? Как кто-то может понять это?

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

Всегда исходите из добрых намерений.

Код может быть написан не так, как вы его написали бы. Скажем яснее: код редко пишется одинаково двумя разными людьми. В конце концов, код — это ремесло, а не работа на конвейере.

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

Уточните действие и уровень важности.

Если вы делаете необязательное предложение, например, «нитку», в которой нет необходимости до того, как код будет одобрен для производства, четко скажите об этом.

Если вам интересно, почему человек сделал тот или иной выбор, но это не влияет на то, должен ли код быть запущен в производство, скажите об этом ясно.

Если вы уверены, что код необходимо исправить, прежде чем он будет готов к работе, четко скажите об этом.

Совет для профессионалов. Когда мы пишем, мы часто думаем, что наши намерения ясны. Ведь мы знаем, что пытаемся сказать. Но помните, что наши тексты не всегда могут быть так ясны для читателя, как для нас, и убедитесь, что ваши самые основные указания ясны и прямолинейны.

Не забывайте, что обратная связь по коду — и любая обратная связь — включает в себя похвалу.

Само собой разумеется, что ключевым преимуществом проверки кода является улучшение кода и устранение проблем.

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

Если кто-то написал особенно элегантный или удобный для сопровождения код или принял правильное решение об использовании библиотеки, дайте ему знать!

В Sema мы говорим, что всегда самое подходящее время, чтобы оставить положительный, конкретный отзыв. Но, конечно же, мы ведем разговоры, когда дело доходит до код-ревью.

Узнайте больше о плюсах и минусах проверок кода и их влиянии на корпоративную культуру в нашем техническом описании: www.semasoftware.com/blog/code-reviews-101-the-basics

Также опубликовано [Здесь] (https://www.semasoftware.com/blog/the-5-golden-rules-of-code-reviews)