La référence à un bogue / problème dans le message de validation est-elle considérée comme une bonne pratique?

11

Je travaille sur un projet où nous avons le contrôle de code source configuré pour écrire automatiquement des notes dans le traqueur de bogues. Nous écrivons simplement l'ID de problème de bogue dans le message de validation et le message de validation est ajouté en tant que note au traqueur de bogues.

Je ne vois que quelques inconvénients pour cette pratique. Si dans le futur, le code source est séparé du logiciel de suivi des bogues (ou les bogues / problèmes signalés sont en quelque sorte perdus). Ou lorsque quelqu'un consulte l'historique des validations mais n'a pas accès à notre outil de suivi des bogues.

Ma question est de savoir si avoir une référence de bogue / problème dans le message de validation est considéré comme une bonne pratique? Y a-t-il d'autres inconvénients?

programming-practices version-control issue-tracking Christian P
la source

Réponses:

10

Nous avons adopté cette pratique et cela fonctionne très bien pour nous. L'intégration étroite entre le système de contrôle de version (VCS) et d'autres systèmes que nous utilisons, par exemple l'intégration continue, le suivi des bogues, etc. est extrêmement précieuse. Si nous changeons quelque chose à l'avenir, nous devrons certainement évaluer les effets secondaires, y compris les liens entre le VCS et le système de suivi des bogues.

En général, je verrais cela comme une bonne pratique. Pour certains systèmes de suivi, des options et outils supplémentaires sont disponibles, par exemple les propriétés bugtraq pour Subversion (SVN). Cela suggère que bon nombre de personnes voient la valeur de cette pratique.

Manfred
la source
13

Si vous voulez vraiment, vraiment être sûr qu'aucune information n'est perdue même si vous pouvez utiliser un autre tracker de bug à l'avenir ou que vos données de tracker de bug disparaissent d'une manière ou d'une autre, pourquoi ne pas simplement mettre à la fois l'ID du problème et une brève explication sur le bug dans le message de validation?

Correction du bug # 123: l'application s'est bloquée après la connexion

Ensuite, vous avez toujours le lien de l'historique des validations vers le suivi des bogues - et si le suivi des bogues ne devait jamais être disponible, vous pouvez toujours voir dans l'historique de quoi parlait ce bogue particulier.

Christian Specht
la source
Nous le faisons en fait, nous n'avons donc pas besoin de passer au bug tracker à chaque fois que nous parcourons l'historique des commits.
Christian P
D'accord, alors je le laisserais tel quel. OMI, c'est la meilleure façon de le faire!
Christian Specht
1
Oui, bon point. C'était mon hypothèse de toute façon, cependant. Juste l'ID de bogue / problème seul n'est pas assez bon dans mon expérience. En regardant le journal de commit, vous voulez toujours voir de quoi parlait chaque commit, par exemple quelle était la raison générale de ce changement de code. Parfois, le message de validation est plus du côté technique tandis que le texte du système de suivi des bogues s'adresse davantage aux utilisateurs du logiciel.
Manfred
Cela a généralement été la pratique standard où j'ai également travaillé, je pense que c'est la bonne façon de le faire.
Carson63000
+1 toujours faire ça! Je viens de prendre en charge la maintenance d'un projet rempli de gemmes comme "cela a peut-être été la cause du bug 5423". Nous n'avons pas accès à leur tracker de bug.
Kryptic
2

Il s'agit d'une pratique très courante et je l'ai trouvée extrêmement pratique. J'utilise TRAC, donc je peux lire l'historique du code et accéder à la tâche qui a entraîné la modification, ou lire l'historique de la tâche et accéder aux modifications du code.

"Si dans le futur ..." Si vous séparez le code du traqueur de bogues, l'ancien historique des révisions ne sera probablement plus intéressant.

Kevin Cline
la source
2

J'utilise aussi cette pratique et je la considère comme très bonne. Mais en plus de l'ID du problème, j'ajoute une courte description du bug / de la fonctionnalité (généralement le titre du système de suivi des bogues). Cela permet souvent de gagner du temps car je n'ai pas à rechercher dans le système de suivi des bogues (car je reconnais le changement) ET, comme vous l'avez dit, si je perds le système de suivi des bogues, je ne suis pas complètement perdu.

Nicolae Albu
la source