Cette compétence sera invoquée lorsque l'utilisateur souhaite créer une demande de refactorisation. Vous devez suivre les étapes ci-dessous. Vous pouvez ignorer certaines étapes si vous ne les jugez pas nécessaires.
-
Demandez à l'utilisateur une description longue et détaillée du problème qu'il souhaite résoudre ainsi que toute idée potentielle de solution.
-
Explorez le dépôt pour vérifier ses affirmations et comprendre l'état actuel du codebase.
-
Demandez-lui s'il a envisagé d'autres options, et présentez-lui d'autres options.
-
Interviewez l'utilisateur sur l'implémentation. Soyez extrêmement détaillé et minutieux.
-
Définissez précisément le périmètre de l'implémentation. Déterminez ce que vous prévoyez de modifier et ce que vous prévoyez de ne pas modifier.
-
Recherchez dans le codebase la couverture de tests pour cette zone du code. Si la couverture est insuffisante, demandez à l'utilisateur quels sont ses plans de test.
-
Décomposez l'implémentation en un plan de minuscules commits. Rappelez-vous le conseil de Martin Fowler : « faites chaque étape de refactorisation aussi petite que possible, afin de toujours voir le programme fonctionner ».
-
Créez une issue GitHub avec le plan de refactorisation. Utilisez le modèle suivant pour la description de l'issue :
<modèle-plan-refactorisation>
Énoncé du problème
Le problème rencontré par le développeur, du point de vue du développeur.
Solution
La solution au problème, du point de vue du développeur.
Commits
Un plan d'implémentation LONG et détaillé. Rédigez le plan en anglais simple, en décomposant l'implémentation en commits les plus minuscules possible. Chaque commit doit laisser le codebase dans un état fonctionnel.
Document de décision
Une liste des décisions d'implémentation qui ont été prises. Cela peut inclure :
- Les modules qui seront construits/modifiés
- Les interfaces de ces modules qui seront modifiées
- Les clarifications techniques du développeur
- Les décisions architecturales
- Les modifications de schéma
- Les contrats d'API
- Les interactions spécifiques
N'incluez PAS de chemins de fichiers spécifiques ou d'extraits de code. Ils pourraient rapidement devenir obsolètes.
Décisions de test
Une liste des décisions de test qui ont été prises. Incluez :
- Une description de ce qui constitue un bon test (tester uniquement le comportement externe, pas les détails d'implémentation)
- Quels modules seront testés
- Les précédents pour les tests (c'est-à-dire des types de tests similaires dans le codebase)
Hors périmètre
Une description des éléments qui sont hors périmètre pour cette refactorisation.
Notes supplémentaires (optionnel)
Toutes notes supplémentaires concernant la refactorisation.
</modèle-plan-refactorisation>