Sur la base d' un commentaire et des votes positifs ultérieurs de Bug ropen vs. new :
Citer les identifiants de bogues dans les notes de mise à jour est tout simplement ... très hostile. - Krelp
Il semble qu'au moins certaines personnes pensent que référencer les ID de bogues dans les notes de mise à jour n'est pas une bonne idée. Je suis un développeur assez inexpérimenté, alors je me demande pourquoi c'est le cas.
issue-tracking
bug-report
software-patches
Travis Northcutt
la source
la source
Réponses:
À mon avis, c'est une bonne pratique, en supposant que vos utilisateurs ont un accès en lecture à votre base de données de bogues. Il y a de nombreuses fois où les gens attendent qu'un bug particulier soit corrigé pour décider quand mettre à jour.
Je pense que ce qui est mal vu ne cite que l'identifiant du bug et rien d'autre. Vous devez également toujours fournir une description compréhensible sans passer par le suivi des bogues. Cela vous permet également de changer de suivi des bogues à l'avenir sans invalider entièrement vos notes de version précédentes.
la source
Il est, comme dit dans le commentaire cité ... hostile.
Peu amical avec vous-même
Imaginez le scénario suivant. Vous consultez les journaux dans le contrôle de code source. Vous vous demandez ce qu'un changement a changé. Au lieu de l'expliquer en anglais simple, il vous dit:
Vous exécutez le système de suivi des bogues, en espérant avoir quelque chose d'utile. Le bogue n ° 1307 est signalé comme résolu. Dans la description, vous voyez:
Merci, c'est très utile. Vous devez maintenant accéder au rapport de bogue # 1284 pour lire qu'il s'agit d'un doublon du bogue # 1113 qui fait référence aux bogues # 1112, # 1065 et # 1067.
Cinq minutes plus tard, vous n'avez aucune idée de ce que vous recherchez au début.
Un message de journal de contrôle de version beaucoup plus utile serait:
De la même manière, dans le système de suivi des bogues, le rapport # 1307 pourrait être plus explicite , rappelant en quoi consistait le rapport de bogue # 1284 et en quoi le nouveau est différent de l'ancien.
Peu amical avec les clients
Ce n'est pas le seul problème de convivialité.
Un deuxième est qu'en faisant trop de références sans informations supplémentaires, vous rendez les notes de patch / journaux de contrôle de version / rapports de système de suivi des bogues inutilisables pour quelqu'un qui n'est pas très familier avec ces systèmes . Lorsque vous traitez quotidiennement avec un système de suivi des bogues, vous savez comment naviguer rapidement dans les rapports, afficher plusieurs rapports côte à côte, etc. Lorsque vous êtes un client sans expérience technique, vous pouvez facilement vous perdre.
Là encore, des messages plus détaillés sont très utiles qu'une simple référence. Notez que vous souhaitez toujours conserver les références: rien n'est plus faux qu'un bug qui est le même qu'un bug que vous avez rencontré il y a deux semaines, mais ne vous souvenez pas de son ID.
À noter que le même problème existe dans de nombreuses juridictions. En France par exemple, il n'est pas rare qu'une législation fasse référence à de multiples sources, qui peuvent évoluer entre-temps. Cela signifie que pour le comprendre complètement, vous devez parfois passer des heures dans une bibliothèque, à rechercher des dizaines de textes référencés, chaque texte ayant ses propres références aux autres.
la source
Il n'y a rien de mal à citer les numéros de problème dans les notes de mise à jour, à condition que les utilisateurs puissent lire le problème cité. Si votre base de données de bogues permet à quiconque de lire, citer le numéro de bogue peut être très utile. (Mieux encore, si vos notes de mise à jour sont dans un format qui autorise les liens, faites que ces ID de problème soient des liens vers le problème en question.) Cela ne signifie pas que vous devez exposer tous les problèmes au grand public; il peut toujours être utile d'en avoir des qui sont enveloppés (par exemple, où ils ont des mots de passe en direct!)
Citer un numéro de problème où la personne qui lit ne peut pas aller chercher les détails et l'historique du bogue, c'est assez hostile. Ce n'est pas que citer de tels problèmes sans l'ID du problème est beaucoup plus convivial.
la source
Cela dépend évidemment de qui sont les personnes qui liront les notes de mise à jour et les utilisateurs cibles du logiciel.
Mais dans la plupart des cas, la grande majorité de vos utilisateurs ne se soucient tout simplement pas de l'ID du bogue. Ils ne se soucient pas de la raison pour laquelle il a été cassé, de la nature du correctif ou de toute autre chose - ils veulent seulement savoir ce qui a changé avec une description textuelle très succincte sans avoir à aller sur une autre page pour chaque changement.
Citer les ID de bogue me fait arrêter et réfléchir, et moi, en tant qu'utilisateur, je ne veux pas penser. C'est en quelque sorte un problème de convivialité.
Jetez un oeil par exemple au journal des modifications de Visual Assist X . Tous ces ID de bogue liés ne sont que du bruit qui me distrait de comprendre ce qui a changé. Et ceci est un module complémentaire pour Visual Studio, ciblant les programmeurs. Et je suis programmeur. Si cela me dérange, imaginez l'utilisateur moyen qui ne sait même pas ce qu'est un traqueur de bogues.
PS: j'étais l'auteur du commentaire qui a déclenché la question
la source
Un ID de bogue est obligatoire pour un point de référence . Les raisons:
est plus pratique que:
la source
Je dirais que cela dépend de votre système: j'ai de la chance que celui que j'utilise détecte automatiquement ces références dans les messages de commit et ajoute un lien vers le ticket stocké dans le bug tracker, donc ce n'est pas un problème.
Mais si j'étais sur un système où il n'est pas disponible, je mentionnerais toujours l'ID du ticket (de cette façon, vous pouvez rechercher rapidement dans les journaux par ID de ticket ) ainsi qu'une brève description de ce qu'est le bogue.
la source