Code review guideline

code_review_guidelines.md

Code review guidelines

Based on a list Michael Azerhad published on linkedin.

1. La portée des variables/méthodes/classes
2. Les traces de muabilité là où l'immuabilité est plus adéquate
3. L'indentation
4. Le nommage des méthodes, classes et variables
5. L'orthographe et la grammaire => très important
6. Les duplications de code
7. Les violations de couplage (du métier dans un contrôleur par exemple)
8. La consommation mémoire (si on peut éviter N appels, des instances inutilement créées à la volée, ou bien transposer une logique de filtrage à la BDD plutôt qu'au code)
9. La Big O Notation des algorithmes, toujours choisir la plus optimiale lorsque cela n'est pas insurmontable et est significatif par le contexte
10. Les nature de params/typage de méthodes/fonctions
11. Une nécessité de multithreading quand le jeu en vaut la chandelle
12. La qualité des différents types de test (unitaires/intégration/acceptation/end2End)
13. La qualité du respect du mindset TDD, avec quelques discussions avec le dev, voire un coup de mutation testing
14. Les violations du concept SOLID
15. Le respect de la spécification du besoin, avec une exécution sur une branche Git temporaire du code complet
16. La présence des transactions (queries)
17. Le choix des collections
18. L'overkillité
19. Incorrect Typecasting
20. Useless de/serilization
21. Hardcoded values and configuration parameters
22. Long boolean operations