Voici un checklist qui, je pense, s’appliquera à la plupart des revues de code de backend.
Certaines de ces vérifications, telles que Code Style, devraient idéalement être appliquées et détectées dans le pipeline CI. Cependant, je les ai inclus ici par souci d’exhaustivité.
Vous pouvez utiliser cette liste de contrôle comme point de départ et l’adapter à vos besoins spécifiques.
Style du code
Vérifier que le code respecte les directives de style de codage convenues.
Maintenabilité du code
Vérifier que le code respecte les principes du code propre (ou tout autre principe convenu).
Exigences
Vérifier que le code répond aux exigences spécifiées.
Vérifier que le nouveau code n’interrompt aucune fonctionnalité existante.
Conception de l’API
Vérifier que toute nouvelle API respecte les lignes directrices convenues en matière de conception d’API.
Documentation et commentaires
Vérifier que la logique complexe ou les décisions non évidentes sont couvertes par des commentaires clairs.
Vérifier que toute documentation interne ou externe requise sur le code est fournie, en fonction des processus de documentation convenus.
Traitement des erreurs
Vérifier que les exceptions sont gérées correctement et que les messages d’erreur sont informatifs.
Sécurité
Vérifier que les données d’entrée sont correctement validées.
Vérifier que les données sensibles (mots de passe, jetons) sont stockées en toute sécurité et ne sont pas divulguées dans les journaux.
Examinez le code pour détecter d’éventuelles failles de sécurité, telles qu’une injection SQL ou des problèmes d’authentification.
Dépendances
Vérifier que les dépendances sont à jour et qu’elles ne présentent pas de failles de sécurité connues.
Vérifier que les modifications importantes sont prises en compte lors de la mise à jour des dépendances.
Journalisation
Vérifier que les endroits critiques du code sont couverts par des journaux utiles au débogage.
Vérifier que la journalisation respecte les lignes directrices convenues en la matière.
Tests
Vérifier que le code est couvert par les types de tests automatisés appropriés.
Performance
Évaluer le code pour détecter les problèmes de performance (mémoire, CPU, réseau).
Vérifier que les requêtes de la base de données sont optimisées.
Contrôle des versions
Vérifier que le flux de travail et les pratiques convenus en matière de contrôle de version sont respectés.
Orthographe
Vérifier que l’orthographe est correcte, car cela rend le code plus facilement consultable.
What else ?
Leave a Reply