Sådan gør du dine kodevurderinger sjove (og ikke frygtelige)

Jeg har gjort en god del af kodevurderinger. Ved rimelig andel mener jeg meget. Har du nogensinde foretaget en kodeanmeldelse af en episk funktion? Jeg har. Det var ikke en stor oplevelse, for da den 100. fil skulle gennemgås, var jeg allerede træt af at se på koden. Jeg var så tæt på bare at gå "Yup, ser godt ud for mig" og derefter give min godkendelse.

Men sådan fungerer kodevurderinger ikke. Når du er startet, skal du holde fast ved det og afslutte det til slutningen. Sikker på, du kan tage pauser, men så begynder du at miste konteksten og er nødt til at starte forfra, sådan her:

Jeg afviger dog. Smerten er ikke det, jeg skal tale om.

Så hvordan gør vi det, siger, mindre forfærdeligt? Først, selv inden vi anmodede om pull, og selv før vi begyndte at kode, skulle vi gøre det til et punkt at nedbryde funktioner i pæne små stykker. Udvikling og implementering bliver hurtigere, da det altid er lettere at implementere en mini-funktion end en episk. Dette gør kodevurderinger nemmere og hurtigere at udføre, da ændringerne er ret små.

Store! Jeg håber, du kunne lide min artikel. Lad os alle gå hjem ...

Vent, stop !

Det handlede om, hvordan man gør det mindre forfærdeligt, men hvad med at gøre det sjovt?

Brug af memer i kodevurderinger

Ansvarsfraskrivelse: Følgende er mine egne tanker og ikke min arbejdsgiver.

Jeg ville bare få det ud af vejen, fordi dette potentielt kan være et kontroversielt emne. Under alle omstændigheder gør vi vores kodevurderinger lyse ved at tilføje memer.

Jeg kan høre dit øje rulle herfra! Hør mig dog ud. Hvilken bedre forklaring end at linke til en anden, der gerne allerede har forklaret det?

Det er en tone, der hjælper med at gøre det sjovt for både korrekturlæseren og den person, hvis kode bliver gennemgået. Et eksempel ville være den allerførste "hæfteklammer" i min image wallet. Jeg bemærkede, at Rubocop manglede nogle dobbeltrum i vores filer, så når nogen sendte en pull-anmodning med en masse ekstra hvidt rum, var det en no-brainer at give dem en doge.

Det var et simpelt billede, og alligevel var beskeden meget effektiv. Jeg kan huske, at folk lo, da de så det. Folk ville ikke blive "dogede", så alle var mere opmærksomme i deres ekstra hvide rum.

Det var lettere at åbne finderen, trække dogen til en kommentar og skrive, i stedet for bare at skrive den almindelige gamle Please remove the extra whitespacei pull-anmodningen (PR), især hvis der var flere hunde.

Kunne det ikke komme i brand igen?

Det kunne det helt. Jeg siger ikke, at alle skal følge vores team. Det afhænger virkelig af holdets personlighed. Vores har en gennemsnitsalder på seks år min junior, hvilket betyder, at de fleste kan relateres til memes. Det ville være en anden historie, hvis dit hold har en gennemsnitsalder på fyrre (medmindre de selvfølgelig var beboere i 4chan eller er opdaterede med de seneste memes!).

Du kender virkelig dine holdkammerater bedst. Efter et par måneder med at være sammen (især da vi parrede næsten 100% af tiden), havde vi en slags fornemmelse af hinandens humor, så at sige. Dette gjorde os komfortable med at se memer i vores PR'er og bare grine af det (mens vi selvfølgelig løste problemet).

Hvilke fordele får du af memer?

Nå, en fordel er, at det gør gennemgangen hurtigere (i det mindste for mig). Den person, der også indsendte PR, forstår faktisk, hvad de skal gøre hurtigere. I stedet for at læse et par ord ser du et billede - og vi ved alle, at billeder taler højere end ord. Her er et par eksempler fra min personal image wallet™:

Når jeg frembringer et billede for første gang, tilføjer jeg en beskrivelse / forklaring på, hvad de skal gøre / rette. Ovenstående siger grundlæggende fjern ovenstående "arv" -kode. Slet det. Ødelæg det!

Dette er specifikt for Ruby - pretzel dotoperatøren er dybest set en genvej til en try-catch. Jeg fremhæver bare det uddrag, der har brug for en kringle, og indsætter dette billede. Hurtigt og let!

Disse to bruger jeg bare om og om igen, mest i Ruby, hvor vi altid tilføjer den # frozen_string_literal: truemagiske kommentar øverst i filen. Med Rubocop ved roret har vi dog set mindre og mindre af Elsa og Mr. Freeze. De dukker også op for enhver konstant, der skal fryses.

Dette er ret ligetil (håber jeg). Når kolleger ser dette, er det et tegn på, at de havde en skrivefejl. Jeg fremhæver normalt også skrivefejl, så det er hurtigt og nemt at se (og rette).

Dette er blot nogle få af dem. Husk dog, for meget af noget er normaltikke en god ting. Så pas på, når du tilføjer dine memer. Det er også bedst ikke at tilføje for mange memer, da det nogle gange kan blive distraherende. At finde den rette balance mellem tone og bare sende meddelelsen så hurtigt som muligt er den bedste måde at afslutte en pull-anmodning på.

Det var alt folkens

Afslutningsvis er det virkelig op til dig, hvis du vil have det sjovt eller bare være seriøs og professionel på arbejdspladsen. Nogle synes måske, at memes er uprofessionelle - og det er det sikkert i formelle arbejdsemner. Man kan argumentere for, at en pull-anmodning kan være eller er en formel arbejdsrelateret ting, men jeg tror, ​​den gælder kun, hvis du bruger den til dokumentation eller gennemgang. Ellers tror jeg, det er "ytringsfrihed" (ja, trak det kort!) Og skal bare tages som det er.

For mig formidler det, hvad jeg vil sige: Fjern ekstra mellemrum, rett stavekontrol, frys en konstant eller fjern en linje eller linjer med kode. Jeg behøver ikke skrive meget, min kollega behøver ikke at læse en flok ord mod en anden flok ord, og det lyser stemningen lidt op. Alle vinder! Med det slutter jeg dette med endnu et af mine billeder: