En tant que développeur, j’ai toujours eu du mal avec les révisions de code, car je ne savais pas par quoi débuter ou du moins comment trouver une bonne approche pour le faire. J’ai cherché sur Internet pour trouver des guides et des conseils pour une bonne revue.
J’ai trouvé de nombreux sites web, mais aucun d’entre eux n’avait une liste de contrôle claire et simple. Cet article tente de rassembler les informations recueillies sur plusieurs sites web en une simple liste de contrôle que vous pouvez utiliser lorsque vous examinez le code de vos pairs.
Tout d’abord, laissez-moi vous expliquer pourquoi j’aime faire des revues de code (je crois que beaucoup de développeurs n’aiment pas ça) et pourquoi je pense qu’elles sont importantes. Lorsque j’ai commencé dans mon nouveau travail, j’étais submergé par les technologies utilisées dans le projet et la base de code du projet. C’était la première fois que j’utilisais plusieurs technologies et j’avais une dette technique assez importante.
En plus de cela, le projet présente de nombreuses particularités du point de vue commercial. La seule chose qui a accéléré ma compréhension du projet a été la révision du code ! En révisant le code, j’ai pu comprendre de petits bouts de code (caractéristiques) au lieu d’essayer de comprendre le projet dans son ensemble en une seule fois. C’était beaucoup plus facile et, fonctionnalité par fonctionnalité (pull request par pull request (ou merge request)), j’ai pu mieux comprendre le projet et le code lui-même.
Grâce à cela, j’aime maintenant revoir le code ! Je regarde maintenant chaque pull request qui entre dans la base de code parce que je veux vraiment comprendre tous les petits morceaux qui, combinés, constituent le projet.
Bien sûr, il y a beaucoup d’autres avantages à réviser du code. Mais comme le titre l’indique, il s’agit d’un article simple, alors restons simples et directs 🙂
La liste de contrôle :
- ✅ Le code traite-t-il des cas limites ?
- ✅ Voyez-vous des doublons dans le code ? Ce code peut-il être résumé ?
- ✅ Existe-t-il un moyen de rendre le code plus court/plus facile/plus rapide/etc ?
- ✅ Le code est-il difficile à comprendre ? Et qu’en est-il des noms, sont-ils clairs ? Les commentaires dans le code sont-ils bien pensés ?
- ✅ Toutes les variables et méthodes sont correctement nommées ?
- ✅ Toutes les nouvelles variables sont déclarées ?
- ✅ Le changement ajoute-t-il du temps d’exécution ou pose-t-il des problèmes de performance ?
- ✅ Tous les paramètres sont-ils bien définis et du bon type ?
- ✅ Les bibliothèques sont-elles bien importées ? Utilisons-nous des méthodes obsolètes ?
- ✅ Le code suit-il les normes du projet et les conventions de nommage ?
- ✅ Le ton de mes commentaires est positif et ne heurtera pas les sentiments des autres développeurs ?
- ✅ Dans mes commentaires, est-ce que j’évite de donner des ordres et que je donne plutôt des suggestions ? Exemple: Changer cette méthode à xxxx vs Que pensez-vous du changement de cette méthode à xxxx ?
- ✅ Est-ce que je critique le code et non l’auteur ? (Pourquoi avez-vous…. ? vs Quelle est la raison de ce….)
J’espère que vous trouverez cela utile 🙂 vous pouvez utiliser cette liste de contrôle chaque fois que vous critiquez le code. Si vous avez d’autres suggestions, veuillez les ajouter dans un commentaire.
Faites de meilleures critiques, commencez à les aimer et à la fin construisez de grands projets 🙂
