Kako svoje recenzije koda učiniti zabavnima (i ne užasnima)

Odlično sam proveo recenzije koda. Pod poštenim udjelom mislim puno. Jeste li ikad napravili pregled koda epske značajke? Imam. To nije bilo sjajno iskustvo, jer do trenutka kada je trebalo pregledati stotu datoteku, već sam bio umoran gledajući kôd. Bio sam tako blizu da samo kažem "Da, izgleda mi dobro" i onda dam svoje odobrenje.

Ali tako ne rade pregledi koda. Jednom kad započnete, morate se toga držati i dovršiti do kraja. Svakako, možete praviti pauze, ali onda počinjete gubiti kontekst i morate početi ispočetka, ovako:

Ipak odstupam. Bol nije ono o čemu bih trebao razgovarati.

Pa kako to učiniti, recimo, manje strašnim? Prvo, čak i prije nego što podnesemo zahtjev za povlačenjem, pa čak i prije nego što smo započeli s kodiranjem, trebali bismo istaknuti razbijanje značajki na lijepe male komadiće. Razvoj i implementacije postaju brži, jer je uvijek lakše implementirati mini značajku nego epsku. To olakšava i brže vrši preglede koda, jer su promjene prilično male.

Sjajno! Nadam se da vam se svidio moj članak. Idemo svi kući ...

Čekaj, stani !

To je bilo otprilike kako to učiniti manje užasnim, ali kako to učiniti zabavnim?

Korištenje mema u recenzijama koda

Izjava o odricanju odgovornosti: sljedeće su moje vlastite misli, a ne mog poslodavca.

Samo sam to htio maknuti s puta, jer ovo potencijalno može biti kontroverzna tema. U svakom slučaju, naše recenzije koda radimo lagano dodavanjem mema.

Odavde čujem kako vam oko zakoluta! Ipak me saslušajte. Ima li boljeg objašnjenja od povezivanja s nekim tko je to već rado objasnio?

To je ton koji pomaže da bude zabavan i recenzentu i osobi čiji se kôd pregledava. Jedan od primjera bio bi prvi "rezač" u mojem image wallet. Primijetio sam da Rubocopu nedostaju dvostruki razmaci u datotekama, pa kad je netko predao zahtjev za povlačenjem s gomilom dodatnog praznog prostora, nije bilo nimalo pametno dati im dužda.

Bila je to jednostavna slika, a poruka je bila vrlo učinkovita. Sjećam se da su se ljudi smijali kad su to vidjeli. Ljudi se nisu željeli "usidriti" pa su svi bili oprezniji u svom dodatnom bijelom prostoru.

Bilo je lakše otvoriti finder, povući dužda do komentara i objaviti, umjesto da samo utipkate običnu staru Please remove the extra whitespaceu zahtjev za povlačenje (PR), pogotovo ako je bilo više duždova.

Zar se to ne bi moglo povratiti?

Moglo je potpuno. Ne kažem da bi svi trebali pratiti naš tim. To stvarno ovisi o osobnosti momčadi. Naš ima prosječnu dob šest godina mlađu od mene, što znači da se većina može odnositi na meme. Druga bi priča bila da vaš tim ima prosječnu starost od četrdeset godina (osim ako naravno nisu bili stanovnici 4chana ili su u toku s najnovijim memovima!).

Zapravo najbolje poznajete svoje suigrače. Nakon nekoliko mjeseci međusobnog zajedništva (pogotovo jer smo uparivali gotovo 100% vremena), nekako smo imali osjećaj za humor, da tako kažem. To nam je učinilo ugodno vidjeti meme u našim PR-ima i samo se nasmijati (dok smo, naravno, riješili problem).

Kakve koristi imate od memova?

Pa, jedna je prednost što pregled čini bržim (barem za mene). Osoba koja je također predala PR zapravo razumije što treba brže učiniti. Umjesto da pročitate nekoliko riječi, vidite sliku - i svi znamo da slike govore više od riječi. Evo nekoliko primjera iz mog personal image wallet™:

Kad prvi put iznesem sliku, dodam opis / objašnjenje što trebaju učiniti / popraviti. Gore navedeno u osnovi govori o uklanjanju gornjeg "naslijeđenog" koda. Obriši. Uništi ga!

Ovo je specifično za Ruby - pretzel dotoperater je u osnovi prečica za a try-catch. Samo ističem isječak koji treba perec i zalijepim ovu sliku. Brzo i jednostavno!

Njih dvoje jednostavno koristim naizmjenično i opet, NAJVIŠE u Ruby, gdje uvijek dodajemo # frozen_string_literal: truečarobni komentar na vrh datoteke. No s Rubocopom na čelu, sve smo manje viđali Elsu i gospodina Freezea. Također se pojavljuju za sve konstante kojima je potrebno smrzavanje.

Ovo je prilično jednostavno (nadam se). Kad kolege to vide, znak je da su imali pogrešku u kucanju. Obično ističem i pogrešku u kucanju, tako da je brza i laka za vidjeti (i popraviti).

Ovo je samo nekoliko njih. Imajte na umu da je previše nečega običnonije dobra stvar. Zato samo pripazite kad dodate svoje meme. Također je najbolje ne dodavati previše memova, jer ponekad to može ometati. Pronalaženje odgovarajuće ravnoteže tona i samo što brže slanje poruke najbolji je način zaključivanja zahtjeva za povlačenjem.

To je sve narode

Zaključno, na vama je stvarno želite li se zabaviti ili jednostavno ostati ozbiljni i profesionalni na poslu. Neki možda misle da su memovi neprofesionalni - i sigurno, u formalnim radnim stvarima mogu biti. Može se tvrditi da zahtjev za povlačenjem može biti ili je formalna stvar koja se odnosi na posao, ali mislim da se odnosi samo ako ga koristite za dokumentaciju ili preglede. Inače, mislim da je to "slobodan govor" (da, povukao sam tu kartu!) I da bi ga trebalo uzeti samo onakvim kakav je.

Za mene prenosi ono što želim reći: ukloniti suvišni razmak, popraviti pravopis, zamrznuti konstantu ili ukloniti redak ili retke koda. Ne moram puno tipkati, moj kolega ne mora pročitati hrpu riječi naspram druge hrpe riječi, a to malo razvedri raspoloženje. Svi pobjeđuju! Time ću ovo završiti s još jednom od svojih slika: