Code reviews en goedkeuringen

Codebeoordelingen vormen een hoeksteen van moderne softwareontwikkeling. Het is een systematische controle van broncode door collega's om fouten te vinden en te herstellen die tijdens de eerste ontwikkelingsfase over het hoofd zijn gezien.

De belangrijkste doelen zijn:

• Codekwaliteit verbeteren: Bugs, beveiligingsproblemen en ontwerpfouten vroeg opsporen.
• Kennis delen: Kennis van de codebase verspreiden binnen het team.
• Begeleiding: Ervaren ontwikkelaars kunnen beginnende ontwikkelaars begeleiden en iedereen leert van verschillende perspectieven.

Op GitHub verloopt het codebeoordelingsproces meestal als volgt:

1. Een auteur maakt een pullrequest (PR) met zijn of haar wijzigingen.
2. De auteur wijst beoordelaars toe of vraagt hen om een beoordeling.
3. Beoordelaars bekijken de code en plaatsen opmerkingen en suggesties.
4. De auteur verwerkt de feedback en pusht nieuwe commits naar de PR-branch.
5. Nadat ze tevreden zijn, keuren de beoordelaars de wijzigingen goed.
6. Ten slotte wordt de PR met de hoofdbranch samengevoegd.

Een goede codebeoordeling draait niet alleen om het vinden van bugs; het gaat om het verbeteren van de algehele gezondheid van het project. Let bij een beoordeling op het volgende:

• Correctheid: Doet de code wat deze moet doen? Zijn er randgevallen?
• Leesbaarheid: Is de code gemakkelijk te begrijpen? Zijn de namen van variabelen duidelijk?
• Onderhoudbaarheid: Kunnen anderen deze code later gemakkelijk aanpassen of uitbreiden?
• Prestaties: Zijn er duidelijke inefficiënties?
• Beveiliging: Introduceert de code kwetsbaarheden?

Als beoordelaar moet je feedback altijd constructief en respectvol zijn. Bedenk dat je de code beoordeelt, niet de persoon die deze heeft geschreven.

Tips voor het geven van feedback:

• Wees specifiek: Verwijs naar exacte coderegels.
• Leg het 'waarom' uit: Zeg niet alleen 'verander dit', maar leg uit *waarom* het moet worden gewijzigd.
• Stel oplossingen voor: Bied alternatieve aanpakken of codefragmenten aan.
• Wees vriendelijk: Gebruik beleefde taal en ga uit van goede bedoelingen.

GitHub biedt krachtige hulpmiddelen om het beoordelingsproces te stroomlijnen:

• Opmerkingen bij regels: Klik op een regel in het tabblad 'Gewijzigde bestanden' om rechtstreeks een opmerking toe te voegen.
• Suggesties: Je kunt specifieke codewijzigingen voorstellen die de auteur met één klik kan toepassen.
• Samenvattende beoordeling: Aan het einde kun je een samenvattende beoordeling indienen met de status 'Opmerking', 'Goedkeuren' of 'Wijzigingen aanvragen'.

Suggesties zijn vooral handig voor kleine, duidelijke verbeteringen:

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

Als je de auteur van een pullrequest bent, is reageren op feedback belangrijk. Zo laat je zien dat je betrokken bent en de code wilt verbeteren.

Ga als volgt om met opmerkingen:

• Erken de feedback: Reageer op elke opmerking, al is het maar met 'Goed punt!' of 'Klaar'.
• Breng wijzigingen aan: Push nieuwe commits naar je PR-branch. GitHub werkt de PR automatisch bij.
• Gesprekken oplossen: Zodra je een opmerking hebt verwerkt, markeer je deze op GitHub als 'Opgelost'.
• Stel vragen: Vraag om verduidelijking als je een suggestie niet begrijpt.

De status 'Goedkeuren' is een duidelijk signaal dat een beoordelaar tevreden is met de wijzigingen in een pullrequest. Veel repositories zijn zo ingesteld dat er minstens één (of meer) goedkeuringen nodig zijn voordat een PR kan worden samengevoegd.

Een goedkeuring betekent dat de beoordelaar vindt dat de code:

• aan de vereisten voldoet;
• goed geschreven en onderhoudbaar is;
• alle belangrijke aandachtspunten behandelt.

Dat is het groene licht voor integratie!

Soms heeft een pullrequest meer werk nodig voordat deze kan worden samengevoegd. In zulke gevallen kan een beoordelaar 'Wijzigingen aanvragen' als beoordelingsstatus kiezen.

Deze status maakt duidelijk dat:

• er blokkerende problemen zijn die moeten worden opgelost;
• de PR niet kan worden samengevoegd totdat deze wijzigingen zijn aangebracht en de beoordelaar opnieuw goedkeuring heeft gegeven.

Gebruik deze optie wanneer de problemen aanzienlijk zijn en voorkomen dat de code wordt geaccepteerd.

Om zoveel mogelijk uit codebeoordelingen te halen, moeten zowel auteurs als beoordelaars enkele best practices volgen:

• Houd PR's klein: Kleinere PR's zijn gemakkelijker en sneller te beoordelen.
• Zorg voor duidelijke beschrijvingen: Auteurs moeten gedetailleerde PR-beschrijvingen en context geven.
• Reageer snel: Beoordelaars moeten proberen snel te beoordelen; auteurs moeten vlot reageren.
• Automatiseer wat je kunt: Gebruik linters en geautomatiseerde tests om eenvoudige problemen vóór de beoordeling op te sporen.
• Leer van beoordelingen: Zie elke beoordeling als een kans om te leren en te verbeteren.

Je hebt de wereld van codebeoordelingen en de goedkeuringsfuncties van GitHub verkend! We hebben besproken waarom beoordelingen belangrijk zijn voor codekwaliteit en het delen van kennis, hoe een typisch beoordelingsproces verloopt en wat de belangrijkste onderdelen van goede beoordelingspraktijken zijn.

Geef altijd constructieve feedback, gebruik hulpmiddelen van GitHub zoals suggesties en volg best practices bij zowel het beoordelen als het reageren op feedback. Goedkeuringen en 'Wijzigingen aanvragen' zijn belangrijke signalen om je PR's effectief te beheren.

Blijf deze vaardigheden oefenen om een waardevolle samenwerkingspartner te worden!