Revue de code
Table des matières
Bonnes pratiques
- Faire des revues de code régulièrement. Par exemple, dès qu'une fonctionnalité a été ajoutée ou qu'une partie de code est fonctionnelle. Ne pas attendre à la fin du projet pour faire une revue de code.
- Toujours commenter une revue de code. Les commentaires doivent être constructifs (points à améliorer dans le code). Si rien est à signaler, donner un commentaire positif (exemples : bravo, beau travail, code très propre, etc.).
- Les commentaires doivent être clairs, pertinents et sans ambiguïté.
GitHub
La revue de code se fait avant de faire un "merge".
Questions à se poser
Le code
- Le code est-il lisible, clair ou est-il trop complexe ?
- Le code est-il conforme aux bonnes pratiques de programmation ?
- Le code est-il conforme aux normes et standards de programmation ?
Les tests
- Est-ce que les tests vérifient le comportement attendu ?
- Est-ce que les tests vérifient le comportement ou l'implémentation ? Il faut éviter de tester l'implémentation. Il faut tester le comportement.
- Est-ce que les tests sont fragiles ?
- Les mêmes questions que pour le code.
Autres
Selon le contexte, d'autres questions peuvent être posées :
- Est-ce que la sécurité a été considérée (données sensibles, connexion HTTPS, etc.) ?
- Le code est-il optimisé en termes de performance et de consommation de ressources ?
- Est-ce qu'un algorithme peut être amélioré ?
- Le code est-il testé et couvert par des tests unitaires et d’intégration ?
- Etc.