Vous pourriez envisager de prendre quelques idées de Mozilla et Sun sur ce sujet:
Aperçu général d'un rapport de bogue
Résumé : Comment décririez-vous le bug en moins de 60 caractères? Il doit identifier rapidement et uniquement un rapport de bogue ainsi qu'expliquer le problème, et non la solution que vous avez suggérée.
Bon : «L'annulation d'une boîte de dialogue de copie de fichier bloque le gestionnaire de fichiers»
Mauvais : "Le logiciel plante"
Mauvais : "Le navigateur devrait fonctionner avec mon site Web"
Composant : Dans quelle sous-partie du logiciel existe-t-il? Ce champ est obligatoire pour soumettre un rapport de bogue. Cliquez sur le mot «Composant» pour voir une description de chaque composant. Si aucune ne semble appropriée, mettez en surbrillance la composante «Général».
OS : Sur quel système d'exploitation (OS) l'avez-vous trouvé? (par exemple Linux, Windows XP, Mac OS X.) Exemple: «Si vous savez que le bogue se produit sur plusieurs types de système d'exploitation, choisissez« Tous ». Si votre système d'exploitation n'est pas répertorié, choisissez Autre ».
Description : les détails de votre rapport de problème, notamment:
- Vue d'ensemble : il s'agit d'un retraitement détaillé plus large du résumé. Un exemple serait: "Glisser-sélectionner n'importe quelle page plante les builds Mac dans la fonction NSGetFactory".
- Build Id : pour le trouver, allez sur la page «à propos de» via la barre d'emplacement ou, si vous avez l'extension Nightly Tester Tools de MozQA, allez dans Outils | Nightly Tester Tools et sélectionnez l'option qui contient la sortie de l'ID de build. Il devrait ressembler à ceci: "Mozilla / 5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv: 1.9.1b3) Gecko / 20090305 Firefox / 3.1b3".
- Constructions et plates-formes supplémentaires : si le bogue se produit ou non sur d'autres plates-formes (ou navigateurs, le cas échéant). Il devrait ressembler à ceci: "N'existe pas sur Mozilla / 5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv: 1.9.1b3) Gecko / 20081107 Firefox / 3.1b2".
Étapes à reproduire : étapes minimisées et faciles à suivre qui déclencheront le bogue. S'ils sont nécessaires, assurez-vous d'inclure toutes les étapes de configuration spéciales. Un bon exemple de ceci ressemblerait à ceci: 1) Affichez n'importe quelle page Web. (J'ai utilisé l'exemple de page par défaut,
http://www.google.com/ ). 2) Faites glisser-sélectionnez la page. Plus précisément, tout en maintenant le bouton de la souris enfoncé, faites glisser le pointeur de la souris vers le bas à partir de n'importe quel point de la région de contenu du navigateur vers le bas de la région de contenu du navigateur.
Résultats réels : ce que l'application a fait après avoir effectué les étapes ci-dessus, par exemple: l'application s'est bloquée.
Résultats attendus : ce que l'application aurait dû faire si le bogue n'était pas présent, par exemple: la fenêtre devrait défiler vers le bas. Le contenu défilé doit être sélectionné. Ou, au moins, l'application ne devrait pas planter.