Kodgranskning

Det här lär du dig

• Vad en granskning (review) är, och varför den görs.
• Att kommentera en rad, och skicka en granskning som kommentar, godkännande eller begäran om ändringar.
• Att svara på en granskning med nya commits.
• Hur man skriver och tar emot synpunkter på ett vänligt sätt.

Varför behövs det här?

Den som har skrivit en ändring ser sällan sina egna misstag. En annan person som läser ändringen hittar fel, ser saker som kan göras enklare och lär sig samtidigt hur projektet fungerar. Granskningen sparas i pull requestenpull requestenPull request (PR)Ett förslag om att föra in ändringarna från en branch i en annan, så att andra kan granska och diskutera dem först.Läs mer om pull requesten, så att man efteråt kan se varför något gjordes som det gjordes.

Så hänger det ihop

En granskning görs under fliken Files changed. Där kan du kommentera enskilda rader. När du är klar skickar du granskningen med något av tre val:

Val	Betyder
Comment	Allmänna synpunkter, utan att godkänna eller kräva ändringar.
Approve	Du godkänner att ändringen förs in.
Request changes	Något måste rättas innan ändringen förs in.

Den som har öppnat pull requesten kan inte godkänna den själv. Godkännandet ska komma från någon annan.

Får du synpunkter rättar du på samma gren hos dig, gör en commit och kör git push. De nya commitsen kommer automatiskt med i pull requesten, och granskaren kan titta igen.

Så fungerar det: AI-assistenter som granskar

Det går att låta en AI-assistent läsa en ändring. Den kan hitta saker som en människa missar, och tvärtom. Men ansvaret för vad som förs in ligger alltid på en människa. I Kodkollektivet skriver AI-agenter kod som granskas av människor, aldrig av agenterna själva.

Exempel

Bra synpunkter är konkreta, vänliga och säger varför:

Mindre bra	Bättre
Fel.	Gävle ligger före Sundsvall längs kusten, så borde inte Gävle vara dag 3 och Sundsvall dag 4?
Gör om.	Kan vi skriva hela namnet, Gävle, i stället för Gvl? Då blir det lättare att läsa.
Ser bra ut (på en stor ändring som du inte har läst)	Läs ändringen, och skriv vad du har kontrollerat.

När du tar emot synpunkter: tänk på att de gäller ändringen, inte dig. Fråga om du inte förstår, och svara på varje kommentar, även om det bara är Rättat.

Övning

Gör så här: granska en pull request

1. Öppna pull requesten från förra lektionen och välj Files changed.
2. Håll muspekaren över en rad och klicka på den blå knappen med plustecken som visas. Skriv en kommentar och välj Start a review.
3. Klicka på Review changes, skriv en sammanfattning och välj ett av alternativen. Klicka på Submit review. Är du ensam kan du bara välja Comment på din egen pull request.
4. Svara på kommentaren genom att ändra filen hos dig, på grenen dag-3-gavle. Gör en commit och kör git push.
5. Ladda om pull requesten. Den nya commiten syns under fliken Commits.

Arbetar ni två: låt den andra granska, och prova Request changes och sedan Approve.

Vanliga problem

Om det inte fungerar: jag kan inte välja Approve

Du är den som har öppnat pull requesten. Den som har skrivit ändringen kan inte godkänna den. Be en medarbetare granska den.

Om det inte fungerar: mina kommentarer syns inte för någon annan

Kommentarer i en granskning väntar tills du skickar granskningen. Klicka på Review changes och Submit review.

Testa dig själv

1. Vilka val har du när du skickar en granskning? (Välj alla som stämmer)

• Comment
• Approve
• Request changes
• Delete

Visa rätt svar

• Comment
• Approve
• Request changes

2. Kan du godkänna din egen pull request?

• Nej, godkännandet måste komma från någon annan
• Ja, om du är ägare till repositoryt

Visa rätt svar

• Nej, godkännandet måste komma från någon annan

3. Vilken kommentar är bäst?

• Kan vi skriva hela namnet, Gävle, i stället för Gvl? Då blir det lättare att läsa.
• Fel.
• Ser bra ut, utan att ha läst ändringen

Visa rätt svar

• Kan vi skriva hela namnet, Gävle, i stället för Gvl? Då blir det lättare att läsa.: Den är konkret och vänlig, och säger varför.

Rätta

Sammanfattning

• En granskning görs under Files changed, med kommentarer på rader.
• Granskningen skickas som Comment, Approve eller Request changes.
• Den som har öppnat pull requesten kan inte godkänna den själv.
• Rätta med nya commits på samma gren och git push. De kommer med i pull requesten.
• Bra synpunkter är konkreta och vänliga, och säger varför.