Kodgranskningar och godkännanden

En bra kodgranskning handlar inte bara om att hitta buggar, utan om att förbättra projektets övergripande kvalitet. Tänk på följande när du granskar:

• Korrekthet: Gör koden det den ska? Finns det specialfall?
• Läsbarhet: Är den lätt att förstå? Är variabelnamnen tydliga?
• Underhållbarhet: Kan andra enkelt ändra eller utöka koden senare?
• Prestanda: Finns det uppenbara ineffektiviteter?
• Säkerhet: Introducerar den några sårbarheter?

Som granskare ska din återkoppling alltid vara konstruktiv och respektfull. Kom ihåg att du granskar koden, inte personen som skrev den.

Tips för att ge återkoppling:

• Var specifik: Peka på exakta kodrader.
• Förklara varför: Säg inte bara 'ändra detta', utan förklara *varför* det bör ändras.
• Föreslå lösningar: Erbjud alternativa angreppssätt eller kodexempel.
• Var vänlig: Använd ett artigt språk och utgå från goda avsikter.

GitHub tillhandahåller kraftfulla verktyg som effektiviserar granskningsprocessen:

• Radkommentarer: Klicka på en rad på fliken 'Files changed' för att lägga till en kommentar direkt.
• Förslag: Du kan föreslå specifika kodändringar som upphovspersonen kan tillämpa med ett enda klick.
• Sammanfattande granskning: I slutet kan du skicka in en sammanfattande granskning med statusen 'Comment', 'Approve' eller 'Request changes'.

Förslag är särskilt användbara för små, tydliga förbättringar:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Om du är upphovsperson till en Pull Request är det viktigt att svara på återkopplingen. Det visar att du är engagerad och vill förbättra koden.

När du hanterar kommentarer:

• Bekräfta: Svara på varje kommentar, även om det bara är för att säga 'Bra synpunkt!' eller 'Klart'.
• Gör ändringar: Skicka nya bekräftelser till din PR-gren. GitHub uppdaterar PR:en automatiskt.
• Markera diskussioner som lösta: När en kommentar har hanterats markerar du den som 'Resolved' på GitHub.
• Ställ frågor: Be om ett förtydligande om du inte förstår ett förslag.

Statusen 'Approve' är en tydlig signal om att en granskare är nöjd med ändringarna i en Pull Request. Många arkiv är konfigurerade så att minst ett (eller flera) godkännanden krävs innan en PR kan slås samman.

Ett godkännande visar att granskaren anser att koden:

• Uppfyller kraven.
• Är välskriven och underhållbar.
• Har hanterat alla betydande invändningar.

Det är klartecknet för integrering!

Ibland behöver en Pull Request mer arbete innan den kan slås samman. I sådana fall kan en granskare välja 'Request changes' som granskningsstatus.

Den här statusen kommunicerar tydligt att:

• Det finns blockerande problem som måste lösas.
• PR:en kan inte slås samman förrän ändringarna har gjorts och granskaren har gett ett nytt godkännande.

Använd det här alternativet när problemen är betydande och hindrar koden från att godtas.

För att få ut så mycket som möjligt av kodgranskningar bör både upphovspersoner och granskare följa några principer:

• Håll PR:er små: Mindre PR:er är enklare och snabbare att granska.
• Tydliga beskrivningar: Upphovspersoner bör ge utförliga beskrivningar av PR:er och relevant sammanhang.
• Var snabb: Granskare bör försöka granska snabbt, och upphovspersoner bör svara utan dröjsmål.
• Automatisera det du kan: Använd linters och automatiserade tester för att upptäcka enkla problem före granskningen.
• Lär dig av granskningar: Se varje granskning som en möjlighet att lära dig och förbättras.

Du har utforskat kodgranskning och GitHubs godkännandefunktioner! Vi har gått igenom varför granskningar är viktiga för kodkvalitet och kunskapsdelning, det typiska granskningsflödet och viktiga delar av god granskningspraxis.

Kom ihåg att alltid ge konstruktiv återkoppling, använda GitHubs verktyg som förslag och följa bästa praxis både när du granskar och när du svarar på återkoppling. Godkännanden och 'Request changes' är viktiga signaler för att hantera dina PR:er effektivt.

Fortsätt öva på dessa färdigheter för att bli en värdefull samarbetspartner!