Quand je parcours du code legacy et que je tombe sur un commentaire « TODO : à améliorer un jour »
Lorsqu’on parcourt du code legacy, on peut être confronté à des commentaires laissés par d’anciens développeurs. Parmi ces annotations, on trouve parfois des mentions du type « TODO : à améliorer un jour ». Ce genre de remarque laisse entendre qu’il reste des tâches à compléter ou des portions de code à optimiser. Mais que faire face à ce type de commentaire ?
1. Comprendre le contexte
Avant de se lancer dans l’amélioration d’une partie de code mentionnée dans un « TODO », il est essentiel de comprendre le contexte dans lequel ce commentaire a été laissé. Il peut s’agir d’une fonctionnalité non implémentée, d’un bug connu mais non corrigé ou encore d’une partie de code temporaire en attente d’une refonte.
Dans certains cas, il peut être utile de recueillir des informations supplémentaires auprès de l’équipe de développement initiale pour avoir une vision plus claire de ce qui doit être amélioré.
2. Évaluer l’importance de l’amélioration
Tous les « TODO » ne se valent pas. Certains peuvent concerner des éléments mineurs qui n’ont pas d’impact sur le fonctionnement global de l’application, tandis que d’autres peuvent pointer vers des parties critiques nécessitant une intervention rapide.
Il est donc crucial d’évaluer l’importance de l’amélioration à apporter en fonction de l’impact sur le code existant et sur les utilisateurs finaux. Cela permet de prioriser les tâches et de se concentrer sur les points les plus critiques en premier.
3. Planifier les actions à entreprendre
Une fois le contexte compris et l’importance de l’amélioration évaluée, il est temps de planifier les actions à entreprendre. Cela peut passer par la rédaction d’une user story, la création de tâches dans un outil de gestion de projet ou simplement l’ajout d’une intervention à la feuille de route de l’équipe.
Il est essentiel de définir clairement les étapes à suivre pour effectuer l’amélioration, ainsi que les ressources nécessaires et les délais à respecter. Une planification rigoureuse permet d’assurer la réussite du processus d’amélioration.
4. Implémenter les changements
Une fois les actions planifiées, il est temps de passer à l’implémentation des changements. Cela peut nécessiter de modifier du code existant, d’ajouter de nouvelles fonctionnalités ou de corriger des erreurs. Il est important de suivre les bonnes pratiques de développement et de tester les changements effectués pour garantir leur bon fonctionnement.
Pendant cette phase, il peut être utile de garder une communication ouverte avec les autres membres de l’équipe pour s’assurer que tout se déroule comme prévu et pour obtenir de l’aide en cas de besoin.
5. Documenter les modifications
Une fois les changements implémentés, il est crucial de documenter ces modifications pour que les développeurs futurs comprennent les raisons derrière ces améliorations. Cela peut passer par la mise à jour des commentaires existants, la rédaction de documentation technique ou la création de tests unitaires pour garantir le bon fonctionnement des modifications.
Une bonne documentation permet de pérenniser les changements apportés au code et de faciliter la maintenance et l’évolution de l’application à long terme.
Parcourir du code legacy et tomber sur un commentaire du type « TODO : à améliorer un jour » peut susciter différentes réactions. Plutôt que de voir ce type de remarque comme une contrainte, il est important de l’appréhender comme une opportunité d’améliorer la qualité du code et de contribuer à la pérennité de l’application.
En suivant une approche méthodique, en évaluant correctement les besoins d’amélioration et en planifiant les actions à entreprendre, il est possible de transformer ces « TODO » en réalisations concrètes qui bénéficieront à l’ensemble de l’équipe de développement.
