Skip to the content

Code reviewing enligt Spot On

I juni 2018 deltog Spot On på DevSum-konferensen i Stockholm. En av sessionerna hölls av Amanda Sopkin och hette; Code Reviews: The Good, the Bad, och the Ugly.

Hennes föreläsning handlade mestadels om hur man utför kodgranskning genom att vara ärlig, kommunikativ och öppen. Vi blev så inspirerade av detta att vi bestämde oss för att skriva ett eget kodgranskning-manifest. Håll till godo nedan och använd gärna punkterna i ditt eget arbete!

  • Varför gör vi kodgranskning?
    Kort och gott, för att förbättra oss som utvecklare. Genom att visa och diskutera kod hittar vi inte bara buggar och problem, det är också en överlägsen resurs för oss att lära av varandra och från våra misstag.

  • Kunskapspridning
    Genom att visa din kod till minst en annan person gör teamet mindre personberoende. Detta i sin tur gör också att kunden kan få hjälp snabbare ifall flera av era utvecklare är tillfälligt upptagna.

  • Delat ansvar
    Alla kan och ska göra kodgranskning!
    Det spelar ingen roll om du har arbetat i 1 år eller 10 år, din kunskap är värdefull och som bekant är fler ögon bättre än ett par.

  • Förbättra kodbaskvaliteten
    Den mest uppenbara orsaken till att vi gör kodgranskningar är att koden blir bättre. Och hur gör du bra kod som andra förstår? Läs vårt blogginlägg: Sju tips på att koda så andra förstår | Spot On - experter på e-handel och produktwebb

  • Agera empatiskt och va ärlig
    Vi är alla människor, inte maskiner. Genom att vara empatiska i vår kommunikation mot varandra kommer kodgranskning att bli mer roligt. Men du borde fortfarande vara ärlig och inte rädd för att påpeka om du tycker att en kod kan skrivas annorlunda eller på ett effektivare sätt.

Tips till dig som granskar

Att göra en kodgranskning ska vara ett samarbete mellan utvecklaren och granskaren. Du bygger förtroende genom att dela dina erfarenheter, visa intresse och undvika att göra antaganden. Ta inte för givet att om du granskar en erfaren utvecklarens kod inte hittar något som är viktigt att påpeka. Det finns alltid utrymme för förbättringar!

Säkerställ att utvecklaren förstått sin ursprungliga uppgift. Om det inte är klart för dig som granskare vad uppgiften handlar om, diskutera uppgiftsspecifikationen tillsammans. Om du är öppen för att dela dina erfarenheter av liknande uppgifter under din kodgranskning kan det göra det enklare att föreslå förbättringar av koden.

Om blir ombedd att göra en kodgranskning, försök alltid att ta den från början till slut. Om du ger feedback och utvecklaren justerar koden, se till att det är du som granskar den igen. Lämna det inte till någon annan för att slutföra granskningen. Visa intresse!

Syftet med att ha en öppen diskussion, ge reflektioner och förslag om kod och funktionalitet kan kanske låta uppenbart, men - människor och individer kan lätt få ett stukat självförtroende om kritiken inte framförs på ett bra sätt. Tänk på hur du uttrycker dig själv och hur ni pratar med varandra. Försök att vara öppen när du tittar på en andras arbete. Du kanske tror att din lösning är bäst, men det finns vanligtvis mer än ett sätt att koda. Diskutera det!

Gör inte ett uttalande om hur du tycker att något ska göras utan att fråga utvecklaren du granskar varför ett visst val har gjorts. Under granskningen är det viktigt att utvecklaren kan förklara de val som har gjorts. Det är också viktigt att granskaren försöker att på ett pedagogiskt sätt förklara förslag till förbättringar.

Tips till dig som utvecklar

Försök få till tidiga diskussioner om hur du planerar att bygga något. Det är bättre och lättare att justera vid det tillfället än att behöva göra det i slutet av den slutliga kodgranskningen.

Ibland är det lättare att förklara något muntligt snarare än i skriftlig form. Om möjligt, sitt ner tillsammans och gör kodgranskningen.

När du utvecklar en ny funktion, försök bryta upp saker i mindre "granskningsbara" bitar. Det är varken kul eller lätt att göra en bra kodgranskning om innehållet bara är en stor mängd kod spridd runt lösningen.

Ditt team kommer ha stor nytta av att du fastställer riktlinjer och inställningsmål. Du bör fastställa riktlinjer för hur du skriver din kod i ditt team. Det kommer att hjälpa både utvecklaren att skriva bättre kod och granskaren att luta sig emot under granskningsprocessen. Överväg att skapa en checklista över de saker som granskaren bör vara uppmärksam på när koden granskas.

“Code Review is the single greatest way of noticing and killing bugs, increasing overall understanding, fixing design problems, and learning from each other.”
- Graydon Hoarde

Prenumerera på vårt nyhetsbrev

Spot On