Code review¶
Je past geldende standaarden toe voor opmaaktalen en programmacode en werkt aan onderhoudbare software. Via code reviews geef en ontvang je feedback op code, zodat de kwaliteit en leesbaarheid van de software op niveau blijft. Dit product past bij de leeruitkomst Software.
Code review is het systematisch bekijken van elkaars code vóór of na een merge: is de code leesbaar, volgt hij de afgesproken conventies, zijn er bugs of verbeterpunten? Je kunt dit product invullen door een korte beschrijving van jullie reviewproces en door voorbeelden van gegeven of ontvangen feedback (bijv. in merge requests) te beschrijven of te verwijzen.
Kwaliteitsindicatoren¶
Bij het waarderen van dit product zal er worden gekeken naar de volgende kwaliteitsindicatoren:
- Er is een op zichzelf staand document of onderdeel over code review met duidelijke uitleg.
- Het reviewproces is beschreven (wanneer, hoe, door wie, waar in GitLab).
- Er is aandacht voor geldende standaarden en conventies (code style, naming, structuur).
- Er zijn voorbeelden van gegeven of ontvangen feedback, of verwijzingen naar merge requests waar review heeft plaatsgevonden.
- Er is beschreven hoe feedback wordt verwerkt en hoe dit bijdraagt aan onderhoudbare software.
- Het product sluit aan bij het team en het software-ontwikkelproces in GitLab.
Template¶
Om code review te documenteren, kan je gebruik maken van de volgende template:
# Code review
Korte introductie: wat is het doel van code review in jullie project en hoe past het bij jullie werkwijze?
## Proces
- Wanneer vindt code review plaats? (bij elke merge request, in een vaste ronde, etc.)
- Wie voert de review uit? Waar gebeurt het (GitLab MR, overleg)?
- Waar letten jullie op? (leesbaarheid, conventies, bugs, security, performance)
## Standaarden en conventies
Welke code- en documentatie-standaarden horen jullie te volgen? (taal, framework, naming, comments)
## Voorbeelden
Korte beschrijving of verwijzing naar voorbeelden van code review feedback (bijv. in merge requests). Wat voor feedback geef of ontvang je?
## Verwerking van feedback
Hoe zorg je ervoor dat feedback wordt verwerkt en dat de code verbetert?