Documentation<Précédent | Table des matières | Suivant>
Que mettre dans le rapport de bogue
Instructions pour reproduire le problème Pour pouvoir reproduire le problème, les développeurs doivent savoir ce que vous utilisez, d'où vous l'avez obtenu et comment vous l'avez installé.
Vous devez fournir des instructions précises, étape par étape, décrivant comment reproduire le problème. Si vous devez utiliser des données pour reproduire le problème, joignez le fichier correspondant au rapport de bogue. Essayez de fournir le minimum d'instructions nécessaires pour reproduire le bogue.
Donnez un peu de contexte et définissez vos attentes. Expliquez ce que vous essayiez de faire et comment vous vous attendiez à ce que le programme se comporte.
Dans certains cas, le bug est uniquement dû à une utilisation du programme non prévue par les développeurs. En expliquant clairement votre objectif, vous permettrez aux développeurs de comprendre clairement quand c'est le cas.
Dans d'autres cas, le comportement que vous décrivez comme un bug peut en réalité être normal. Soyez explicite sur ce que vous attendez du programme. Cela clarifiera la situation pour les développeurs. Ils pourront soit améliorer le comportement, soit améliorer la documentation, mais au moins, ils sauront que le comportement de leur programme perturbe certains utilisateurs !
Soyez précis : indiquez les numéros de version des logiciels que vous utilisez, éventuellement avec les numéros de version de leurs dépendances. Lorsque vous faites référence à un téléchargement, indiquez son URL complète.
Lorsque vous recevez un message d'erreur, citez-le exactement tel que vous l'avez vu. Si possible, joignez une copie de votre écran ou une capture d'écran. Joignez également une copie de tout fichier journal pertinent, en veillant à supprimer au préalable toutes les données sensibles.
Mentionnez les correctifs ou solutions de contournement possibles Avant de déposer le rapport de bogue, vous avez probablement essayé de résoudre le problème. Expliquez ce que vous avez essayé et les résultats que vous avez obtenus. Soyez très clair sur ce qui est un fait et ce qui n'était qu'une hypothèse de votre part.
Si vous avez fait une recherche sur Internet et trouvé des explications sur un problème similaire, vous pouvez les mentionner, en particulier lorsque vous avez trouvé d'autres rapports de bogues similaires dans le système de suivi des bogues Debian ou dans le système de suivi des bogues en amont.
Si vous avez trouvé un moyen d'obtenir le résultat souhaité sans déclencher le bug, veuillez également le documenter. Cela aidera les autres utilisateurs confrontés au même problème.
Les rapports de bugs longs sont acceptables. Un rapport de bug de deux lignes est insuffisant ; fournir toutes les informations nécessaires nécessite généralement plusieurs paragraphes (ou parfois pages) de texte.
Fournissez toutes les informations possibles. Essayez de vous en tenir à ce qui est pertinent, mais en cas de doute, mieux vaut en dire trop que pas assez.
Si votre rapport de bogue est vraiment long, prenez le temps de structurer le contenu et de fournir un bref résumé au début.