Propositions de correction
Objectifs pédagogiques
- formuler des retours constructifs
- structurer une proposition d’amélioration
- collaborer efficacement lors d’une revue de code
L’esprit d’une revue de code
- Une revue efficace repose sur : :
- le respect
- la collaboration
- l’amélioration collective
-
Tester les comportements, pas les détails d'implémentation. Testez ce que l’application fait, pas comment elle le fait.
👉 On critique le code, jamais la personne.
Méthode recommandée : Observation – Impact – Suggestion
1️⃣ Observation
- Identifier précisément le problème.
2️⃣ Impact
- Expliquer pourquoi c’est un problème.
3️⃣ Suggestion
- Proposer une amélioration concrète.
Avantages de cette approche
- échanges clairs
- retours mieux acceptés
- décisions plus rapides
- meilleure qualité finale
Exemple de proposition de correction – Application MyEvents
Dans le cadre d’une revue de code sur l’application MyEvents,
un testeur ou un développeur peut être amené à formuler des propositions
d’amélioration de manière structurée.
Contexte
Le module de paiement de MyEvents contient le code suivant :
- logique de validation du paiement
- appel direct à l’API Stripe
- gestion des erreurs dans la même méthode
Application de la méthode OIS
1️⃣ Observation
La méthode
processPayment()regroupe la validation des données, l’appel à l’API de paiement et la gestion des erreurs.
2️⃣ Impact
- la méthode est longue et difficile à lire
- elle est difficile à tester unitairement
- toute modification augmente le risque de régression
3️⃣ Suggestion
Séparer la méthode en plusieurs responsabilités :
- une méthode de validation
- un service dédié au paiement (injectable)
- une gestion centralisée des erreurs
👉 Cette approche améliore :
- la lisibilité du code
- la testabilité (tests unitaires possibles avec des mocks)
- la maintenabilité du module paiement
Lien avec la qualité logicielle
Une bonne proposition de correction contribue directement à : - réduire la dette technique - améliorer la couverture de tests - sécuriser les évolutions futures de MyEvents
Mise en œuvre des améliorations
- prioriser les corrections
- documenter les changements
- valider par des tests
- éventuellement demander une seconde revue
