Како учинити рецензије кода забавним (и не ужасним)

Направио сам свој поштени удео у прегледима кода. Под поштеним уделом мислим пуно. Да ли сте икада урадили преглед кода епске особине? Ја имам. Није било сјајно искуство, јер до тренутка када је требало прегледати 100. фајл, већ сам био уморан гледајући код. Био сам тако близу да само кажем „Да, изгледа ми добро“ и онда дам своје одобрење.

Али тако не функционишу прегледи кодова. Једном кад започнете, морате се тога држати и завршити до краја. Свакако, можете правити паузе, али онда почињете да губите контекст и морате почети испочетка, овако:

Ипак, одступам. Бол није оно о чему бих требало да причам.

Па како да то учинимо, рецимо, мање страшним? Прво, чак и пре него што поднесемо захтев за повлачењем, па чак и пре него што смо почели да кодирамо, требало би да разјаснимо карактеристике на лепе мале комаде. Развој и примене постају бржи, јер је увек лакше применити мини-функцију него епску. Ово олакшава и брже врши прегледе кода, јер су промене прилично мале.

Сјајно! Надам се да вам се свидео мој чланак. Идемо сви кући ...

Стани, стани !

То се односило на то како то учинити мање ужасним, али како на забаву?

Коришћење мема у прегледима кодова

Изјава о одрицању одговорности: следеће су моје мисли, а не мог послодавца.

Само сам желео да то уклоним са пута, јер ово потенцијално може бити контроверзна тема. У сваком случају, наше рецензије кода радимо лагано додавањем мема.

Одавде чујем како вам око заколута! Ипак ме саслушајте. Има ли бољег објашњења од повезивања са неким другим ко је то већ радо објаснио?

То је тон који помаже да забави и рецензента и особу чији се код прегледава. Један од примера био би први „спајалица“ у мом image wallet. Приметио сам да Рубоцопу недостају двоструки размаци у нашим датотекама, па када је неко поднео захтев за повлачење са гомилом додатног празног простора, није било нимало паметно дати им дужда.

Била је то једноставна слика, а ипак је порука била врло ефикасна. Сећам се да су се људи смејали кад су то видели. Људи нису желели да се „дођу“, па су сви били опрезнији у свом додатном белом простору.

Било је лакше отворити претраживач, превући дужда до коментара и објавити, уместо да само Please remove the extra whitespaceоткуцате старо у захтеву за повлачење (ПР), посебно ако је било више дуждова.

Зар се то не би могло повратити?

Могло је потпуно. Не кажем да би сви требало да прате наш тим. Заиста зависи од личности тима. Наш има просечну старост шест година млађу од мене, што значи да се већина може односити на меме. Другачија би била прича да ваш тим има просечну старост од четрдесет година (осим ако наравно нису били становници 4цхана или су у току са најновијим мемовима!).

Заправо најбоље познајете своје саиграче. После неколико месеци међусобног дружења (поготово јер смо упаривали скоро 100% времена), некако смо осетили хумор, да тако кажем. То нам је учинило пријатно да видимо мемове у нашим ПР-има и да се само насмејемо (док смо решавали проблем, наравно).

Какве користи имате од мемова?

Па, једна предност је та што убрзава преглед (барем за мене). Особа која је такође поднела ПР заправо разуме шта треба брже да уради. Уместо да прочитате неколико речи, видите слику - и сви знамо да слике говоре више од речи. Ево неколико примера из мог personal image wallet™:

Када први пут изнесем слику, додам опис / објашњење о томе шта треба да ураде / поправе. Горе наведено у основи говори о уклањању горњег „старог“ кода. Избриши то. Уништи то!

Ово је специфично за Руби - pretzel dotоператер је у основи пречица за а try-catch. Само истичем исечак који треба перец и налепите ову слику. Брзо и лако!

Њих двоје само користим наизменично и опет, НАЈВИШЕ у Руби-у, где увек додамо # frozen_string_literal: trueмагични коментар на врх датотеке. Са Рубоцопом на челу, међутим, све смо мање виђали Елсу и господина Фреезеа. Такође се појављују за било коју константу којој је потребно замрзавање.

Ово је прилично једноставно (надам се). Када колеге ово виде, то је знак да су имали грешку у куцању. Обично истичем и грешку у куцању, па је брзо и лако уочити (и поправити).

Ово је само неколико њих. Имајте на уму да је превише нечега обичноније добра ствар. Зато само припазите када додате своје меме. Такође је најбоље не додавати превише мемова, јер понекад то може да одврати пажњу. Проналажење правог баланса тона и само што брже слање поруке је најбољи начин да се заврши захтев за повлачењем.

То је све народе

Закључно, на вама је стварно да ли желите да се забавите или једноставно останете озбиљни и професионални на послу. Неки могу мислити да су мемови непрофесионални - и сигурно, у формалним радним стварима могу бити. Може се тврдити да захтев за повлачењем може бити или је формална ствар која се односи на посао, али мислим да се односи само ако га користите за документацију или прегледе. Иначе, мислим да је то „слобода говора“ (да, повукао сам ту карту!) И требало би је узети само онакву каква јесте.

За мене преноси оно што желим да кажем: уклоните додатни размак, поправите правопис, замрзните константу или уклоните линију или редове кода. Не морам пуно да куцам, колега не мора да прочита гомилу речи наспрам још једне гомиле речи, и то мало разведри расположење. Сви побеђују! Са тим ћу ово завршити са још једном од мојих слика: