Faire une code review
De manière générale :
- "Don’t accept CLs that degrade the code health of the system"
- Vitesse de la review => un jour ouvré maximum dans l'idéal
En tant que reviewer
Que rechercher
- Design du code : interaction dans le code, intégration avec le reste de notre système
- Fonctionnalité + UX/UI : est-ce que cela fonctionne ?
- Complexité : fonctions trop complexes ? classes trop complexes ?Attention l'over-engineering
- Tests => unitaire ? intégration ? e2e ? Les tests devraient être ajoutés dans la même PR
- Nommage
- Commentaires => est-ce qu'ils sont clairs ? nécessaires ?
- Conforme au style guide => doit faire parti de la CD donc normalement pas trop besoin de commenter
- Documentation
Commentaires
- Expliquer mon raisonnement
- Préfixes & emojis
- "Nit:" pour du nitpicking qui n'est pas obligatoire pour approuver
- Optionnel
- FYI
- Ne pas hésiter à relever les points positifs "If you see something nice in the CL, tell the developer, especially when they addressed one of your comments in a great way."