Как да направите отзивите си за кодове забавни (и не ужасни)

Направих своя справедлив дял от рецензии на кодове. Под справедлив дял имам предвид много. Правили ли сте някога преглед на код на епична функция? Аз имам. Това не беше страхотно изживяване, защото по времето, когато трябваше да се прегледа 100-ият файл, аз вече бях уморен да гледам кода. Бях толкова близо до това да отида „Да, изглежда ми добре“ и след това да дам одобрението си.

Но не така работят прегледите на кодовете. След като започнете, трябва да се придържате към него и да го завършите до края. Разбира се, можете да правите почивки, но след това започвате да губите контекста и трябва да започнете отначало, като това:

Отклонявам се обаче. Болката не е това, за което трябва да говоря.

И така, как да го направим, да речем, по-малко ужасен? Първо, дори преди да направим заявката за изтегляне и дори преди да започнем да кодираме, трябва да направим целта да разделим функциите на хубави малки парчета. Разработването и внедряването стават по-бързи, тъй като винаги е по-лесно да внедрите мини-функция, отколкото епична. Това прави прегледите на кода по-лесни и бързи за извършване, тъй като промените са сравнително малки.

Страхотен! Надявам се статията ми да ви е харесала. Нека всички да се приберем ...

Чакай, спри !

Това беше за това как да го направим по-малко ужасен, но какво ще кажете да го направите забавно?

Използване на мемове в рецензии на кодове

Отказ от отговорност: по-долу са моите собствени мисли, а не на моя работодател.

Просто исках да премахна това, защото това потенциално може да бъде спорна тема. Както и да е, ние правим нашите прегледи на кода леки, като добавяме мемове.

От тук чувам как ти се търкаля окото! Чуйте ме обаче. Какво по-добро обяснение от това да се свържете с някой друг, който с удоволствие го е обяснил вече?

Това е тонът, който помага да бъде забавно както за рецензента, така и за човека, чийто код се преглежда. Един пример би бил първият „основен продукт“ в моя image wallet. Забелязах, че на Rubocop липсват някои двойни интервали в нашите файлове, така че когато някой подаде заявка за изтегляне с куп допълнително празно пространство, не беше добре да им дадем дож.

Това беше просто изображение и въпреки това съобщението беше много ефективно. Спомням си, че хората се смееха, когато го видяха. Хората не искаха да бъдат „догирани“, така че всички бяха по-бдителни в допълнителното си пространство.

По-лесно беше да отворите търсачката, да плъзнете доджа до коментар и да публикувате, вместо просто да напишете обикновения стар Please remove the extra whitespaceв заявката за изтегляне (PR), особено ако имаше няколко дожа.

Не може ли да се обърне?

Напълно можеше. Не казвам, че всеки трябва да следва нашия екип. Това наистина зависи от личността на отбора. Нашият има средна възраст шест години по-млад, което означава, че повечето могат да се отнасят до мемовете. Би било различна история, ако вашият екип е на средна възраст от четиридесет (освен ако, разбира се, те са били граждани на 4chan или са в крак с последните мемове!).

Наистина най-добре познавате съотборниците си. След няколко месеца, в които бяхме помежду си (особено след като сдвоявахме почти 100% от времето), някак си усещахме хумора си, така да се каже. Това ни направи удобно да виждаме мемове в нашите PR и просто да се смеем за това (докато решаваме проблема, разбира се).

Какви ползи имате от мемите?

Е, една полза е, че прави прегледа по-бърз (поне за мен). Човекът, който също е представил PR, всъщност разбира какво трябва да направи по-бързо. Вместо да прочетете няколко думи, виждате изображение - и всички знаем, че изображенията говорят по-силно от думите. Ето няколко примера от моя personal image wallet™:

Когато извадя изображение за първи път, добавям описание / обяснение какво трябва да направят / поправят. Горното основно казва, че премахнете горния „наследствен“ код. Изтрий го. Унищожи го!

Това е специфично за Ruby - pretzel dotоператорът е основно пряк път за a try-catch. Просто подчертавам фрагмента, който се нуждае от геврек, и поставям това изображение. Бързо и лесно!

Тези две просто използвам взаимозаменяемо и отново, НАЙ-МНОГО в Ruby, където винаги добавяме # frozen_string_literal: trueвълшебния коментар в горната част на файла. С Rubocop начело обаче виждаме все по-малко Елза и господин Фриз. Те също се показват за всяка константа, която се нуждае от замразяване.

Това е доста лесно (надявам се). Когато колегите видят това, това е знак, че са имали печатна грешка. Обикновено откроявам и печатната грешка, така че е бързо и лесно да се види (и поправи).

Това са само няколко от тях. Не забравяйте обаче, че твърде много от нещо обикновено ене е хубаво нещо. Така че просто внимавайте, когато добавяте вашите мемове. Също така е най-добре да не добавяте прекалено много мемове, тъй като понякога може да ви отвлече вниманието. Намирането на точния баланс на тона и просто изпращането на съобщението възможно най-бързо е най-добрият начин за приключване на заявката за изтегляне.

Това е всичко приятели

В заключение, наистина от вас зависи дали искате да се забавлявате, или просто да останете сериозни и професионални на работа. Някои може да мислят, че мемовете са непрофесионални - и разбира се, в официални работни неща те могат да бъдат. Може да се твърди, че искането за изтегляне може да бъде или е формално свързано с работата нещо, но мисля, че се прилага само ако го използвате за документация или прегледи. В противен случай мисля, че това е „свобода на словото“ (да, изтеглихте тази карта!) И трябва просто да бъде взето такова, каквото е.

За мен той предава това, което искам да кажа: премахнете излишните интервали, коригирайте правописа, замразете константа или премахнете ред или редове код. Не трябва да пиша много, колегата не трябва да чете куп думи срещу друг куп думи и това леко олекотява настроението. Всички печелят! С това ще завърша с още едно от моите изображения: