Как сделать обзор кода веселым (а не ужасным)

1656631931 kak sdelat obzor koda veselym a ne uzhasnym

Я сделал свою долю проверок кода. Под справедливой долей я имею в виду многое. Вы когда-нибудь проверяли код эпической функции? У меня есть. Это был не очень приятный опыт, потому что к тому времени, когда должен был быть рассмотрен 100-й файл, я уже устал, глядя на код. Я был настолько близок к тому, чтобы просто сказать: «Да, мне это хорошо», а потом дать свое одобрение.

Но проверка кода работает не так. Как только вы начали, вы должны придерживаться этого и закончить до конца. Конечно, вы можете делать перерывы, но потом вы начинаете терять контекст и придется начинать все заново, вот так:

Ck2NsPyZNpjQBRFLQWbadZTPrPhDcpRlsHmf
Мультфильм Джейсона Гириса

Но я отвлекся. Боль — это не то, о чем я должен говорить.

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

Прекрасно! Надеюсь, вам понравилась моя статья. Идем все домой…

подожди, СТОП!

Это было о том, как сделать это менее ужасным, но как насчет того, чтобы сделать это веселым?

Использование мемов в обзоре кода

Отказ от ответственности: это мои собственные мнения, а не мои работодатели.

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

Я слышу отсюда глаза твои! Но выслушайте меня. Какое объяснение может быть лучше, чем ссылка на кого-то другого, кто уже радостно это объяснил?

Это тон, помогающий сделать это весело как для рецензента, так и для лица, чей код проверяется. Одним из примеров может быть самый первый «основной продукт» в моем image wallet. Я заметил, что Rubocop не хватает двойных пробелов в наших файлах, поэтому когда кто-то посылает запрос на вытягивание с кучей дополнительных пробелов, было легко давать ему додж.

nUXPIWCWtNzEIkdH5dS1SlOncwX-6gBtsJPD
Ого. много пробела. таковы разрывы строк.

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

Проще было открыть поисковик, перетащить додж к комментарию и опубликовать, вместо того чтобы просто вводить обычную старуху Please remove the extra whitespace в запросе на получение (PR), особенно если было несколько дожей.

Не могло ли это иметь обратный эффект?

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

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

Какие преимущества вы получаете от мемов?

Ну, одно преимущество состоит в том, что это делает рецензирование более быстрым (по крайней мере, для меня). Человек, который тоже подал PR, действительно скорее понимает, что нужно сделать. Вместо того, чтобы прочитать несколько слов, вы видите изображение — а мы все знаем, что изображения говорят громче слов. Вот несколько примеров из моего personal image wallet™ :

tuGwZyZ1KP1QO56Z8-iljQ007ufkOL9CH1Dw
Удалите эту строчку!

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

14sYrRTvkQ9BvRGHs5tuzXnjREEkGbGVlsjH
Мммм кренделя

Это специфически для Ruby — the pretzel dot Оператор – это в основном короткий путь для a try-catch. Я просто выделяю фрагмент, которому нужен крендель, и вставляю это изображение. Быстро и просто!

qwqPKNzCHncJC19pqxJBbTXM5VQHkiMG4HdF
А-А-А-А!
jvIFwOePL9nOau1UebnU77DdUKD6o9aH83SD
Это действительно меня беспокоит (холод)

Эти два я просто использую как взаимозаменяемые и снова, ОБЩЕ в Ruby, где мы всегда добавляем # frozen_string_literal: true магический комментарий в верхней части файла Но с Рубокопом во главе мы все реже видели Эльзу и мистера Фриза. Они также появляются для любой константы, которую нужно заморозить.

-XyiIVBrpiNFAIK7GWNWqoJA3G0u5alKu4yJ
Люблю этот GIF

Это достаточно просто (я надеюсь). Когда коллеги видят это, значит они ошиблись. Обычно я выделяю ошибку, чтобы ее было быстро и легко увидеть (и исправить).

Это только некоторые из них. Однако помните, что чего-то слишком много обычно не очень хорошо. Будьте осторожны, добавляя свои мемы. Также лучше не добавлять слишком много мемов, поскольку иногда это может отвлекаться. Найти правильный баланс тона и просто отправить сообщение как можно скорее – это лучший способ завершить запрос на получение.

Это все, уважаемые

Подводя итог, от вас действительно зависит, хотите ли вы развлечься, или просто оставаться серьезными и профессиональными на работе. Некоторые могут подумать, что мемы непрофессиональные — и, конечно, в формальной работе это может быть так. Кто-то может спорить, что запрос на получение может быть или является формальным делом, связанным с работой, но я думаю, что это касается только тех случаев, когда вы используете его для документации или просмотра. В противном случае я считаю, что это «свобода слова» (да, вытащил эту карточку!) и ее следует воспринимать так, как она есть.

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

JTYj7y9qsEpADLb-u20Z7dagkFmAO2KgIuA8
МНЕ ЛЮБОПЫТНО

Добавить комментарий

Ваш адрес email не будет опубликован.