Code reviews og godkendelser

Kodegennemgange er en hjørnesten i moderne softwareudvikling. Det er en systematisk undersøgelse af kildekode udført af kolleger for at finde og rette fejl, der blev overset i den første udviklingsfase.

De vigtigste mål omfatter:

• Forbedring af kodekvaliteten: At opdage fejl, sikkerhedssårbarheder og designproblemer tidligt.
• Vidensdeling: At sprede forståelsen af kodebasen i hele teamet.
• Mentorordning: Erfarne udviklere kan vejlede mindre erfarne udviklere, og alle lærer af forskellige perspektiver.

På GitHub følger kodegennemgangsprocessen typisk disse trin:

1. En forfatter opretter en pull request (PR) med sine ændringer.
2. Forfatteren tildeler eller anmoder om reviewere.
3. Reviewerne undersøger koden og skriver kommentarer og forslag.
4. Forfatteren håndterer feedbacken ved at pushe nye commits til PR-grenen.
5. Når reviewerne er tilfredse, godkender de ændringerne.
6. Til sidst merges PR'en ind i main-grenen.

En god kodegennemgang handler ikke kun om at finde fejl; den handler om at forbedre projektets overordnede sundhed. Overvej følgende under gennemgangen:

• Korrekthed: Gør koden det, den skal? Er der særlige kanttilfælde?
• Læsevenlighed: Er den nem at forstå? Er variabelnavnene tydelige?
• Vedligeholdelse: Kan andre nemt ændre eller udvide denne kode senere?
• Ydeevne: Er der åbenlyse ineffektiviteter?
• Sikkerhed: Introducerer den sårbarheder?

Som reviewer skal din feedback altid være konstruktiv og respektfuld. Husk, at du gennemgår koden, ikke personen, der skrev den.

Tips til at give feedback:

• Vær specifik: Peg på de præcise kodelinjer.
• Forklar 'hvorfor': Sig ikke bare 'ændr dette'; forklar, hvorfor det bør ændres.
• Foreslå løsninger: Tilbyd alternative fremgangsmåder eller kodestykker.
• Vær venlig: Brug et høfligt sprog, og antag gode intentioner.

GitHub tilbyder effektive værktøjer, der gør gennemgangsprocessen mere enkel:

• Kommentarer på linjer: Klik på en linje under fanen 'Files changed' for at tilføje en kommentar direkte.
• Forslag: Du kan foreslå specifikke kodeændringer, som forfatteren kan anvende med ét klik.
• Opsummerende gennemgang: Til sidst kan du indsende en opsummerende gennemgang med status som 'Comment', 'Approve' eller 'Request changes'.

Forslag er især nyttige til små, tydelige forbedringer:

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

Hvis du er forfatter til en pull request, er det vigtigt at svare på feedback. Det viser, at du er engageret og dedikeret til at forbedre koden.

Når du håndterer kommentarer:

• Anerkend: Svar på hver kommentar, også selv om det blot er for at sige 'God pointe!' eller 'Udført'.
• Foretag ændringer: Push nye commits til din PR-gren. GitHub opdaterer automatisk PR'en.
• Luk diskussioner: Når en kommentar er håndteret, skal du markere den som 'Resolved' på GitHub.
• Stil spørgsmål: Hvis du ikke forstår et forslag, skal du bede om en forklaring.

Statussen 'Approve' er et tydeligt signal om, at en reviewer er tilfreds med ændringerne i en pull request. Mange repositories er konfigureret til at kræve mindst én (eller flere) godkendelser, før en PR kan merges.

En godkendelse viser, at revieweren mener, at koden:

• Opfylder kravene.
• Er velskrevet og nem at vedligeholde.
• Har håndteret alle væsentlige bekymringer.

Det er grønt lys til integration!

Nogle gange kræver en pull request mere arbejde, før den kan merges. I sådanne tilfælde kan en reviewer vælge 'Request changes' som gennemgangsstatus.

Denne status kommunikerer tydeligt, at:

• Der er blokerende problemer, som skal løses.
• PR'en ikke kan merges, før disse ændringer er foretaget, og revieweren giver en ny godkendelse.

Brug denne mulighed, når problemerne er væsentlige og forhindrer koden i at være acceptabel.

For at få mest muligt ud af kodegennemgange bør både forfattere og reviewere følge nogle gode fremgangsmåder:

• Hold PR'er små: Mindre PR'er er nemmere og hurtigere at gennemgå.
• Tydelige beskrivelser: Forfattere bør give detaljerede PR-beskrivelser og relevant kontekst.
• Vær hurtig: Reviewere bør forsøge at gennemgå hurtigt, og forfattere bør svare hurtigt.
• Automatisér det, du kan: Brug linters og automatiserede test til at finde simple problemer før gennemgangen.
• Lær af gennemgange: Se hver gennemgang som en mulighed for at lære og forbedre dig.

Du har udforsket kodegennemganges verden og GitHubs godkendelsesfunktioner! Vi har gennemgået, hvorfor gennemgange er vigtige for kodekvalitet og vidensdeling, det typiske gennemgangsforløb og de vigtigste elementer i gode gennemgange.

Husk altid at give konstruktiv feedback, bruge GitHubs værktøjer som forslag og følge bedste praksis, både når du gennemgår kode og svarer på feedback. Godkendelser og 'Request changes' er vigtige signaler, når du administrerer dine PR'er effektivt.

Bliv ved med at øve disse færdigheder, så du kan blive en værdifuld samarbejdspartner!