Как сделать код ревью забавным

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

Я всю жизнь проработал программистом и сделал множество ревью кода. И не раз сталкивался с ревью эпик фич, но не могу сказать, что это был успешный опыт. Если вы когда-нибудь делали код-ревью целого подпроекта, то поймете о чём речь. Уже к 100 файлу я так уставал, что был готов просто плюнуть на все и одобрить реквест. Но толку от такого ревью кода нет.

Как же сделать код ревью менее утомительным? Перед началом работы над проектом можно разбить его на подпроекты. Во-первых, разработка будет идти быстрее, во-вторых, если после ревью кода надо будет что-то изменить, изменения будут небольшие.

Тут я бы мог написать “Надеюсь, вам понравилась статья. На этом всё”.

Но подождите!

Это совет, как сделать код ревью не таким угнетающим. Но его же можно сделать ещё и забавным!

Используйте мемы в код ревью

Не все это поймут. У нас в команде код ревью всегда проходит весело.

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

Эта простая картинка оказалась действенной. Все посмеялись и стали внимательнее проверять код перед пул реквестом.

Проще и быстрее отправить мем, который передаст суть проблемы, чем писать длинный комментарий.

А все ли это поймут?

Возможно, нет. Это зависит от отношений, которые сложились. Средний возраст сотрудников в нашей команде 25 лет, поэтому все понимают мемы. Было бы странно, если бы мы 40летние серьезные банковские работники, отправляли друг другу картинки.

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

Какие преимущества это дает?

Я говорил ранее, работа пойдет быстрее. Вместо того, чтобы читать длинный комментарий, вы видите картинку, в которой всё кратко, но емко объяснено. Изображения говорят громче слов. Вот, например:

Когда я впервые отправляю картинку, то добавляю описание / объяснение того, что исправить. Мем выше актуален, когда надо что-то удалить.

А Мистера Фриза я использую в Ruby, где мы добавляем #frozen_string_literal: true волшебный комментарий в верхней части файла. Мистер Фриз появляется для любой константы, которая нуждается в замораживании.Однако с RuboCop у руля мы все реже и реже видим его.

Запомните: перебор это плохо. Не переходите разумную черту и не шлите слишком много мемов, так как это будет просто бесить. Соблюдайте баланс.Тогда это сэкономит время и поднимет настроение всей команде.

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

И напоследок:

Адаптированный перевод статьи How to make your code reviews fun (and not dreadful) от Digital Skynet :)