Guide de rapport de bogues sur IssueZilla

Derni�re mise � jour le 06 Ao�t 2001 (traduction et adaptation fran�aise le 27 Mars 2002)

Les parties fran�aises en italique sont la traduction des champs que vous rencontrerez dans le formulaire.

Pourquoi devez-vous lire ceci

Simplement parce que le plus efficacement vous reportez un bogue, le plus rapidement un ing�nieur le corrigera. Ce guide est un tutoriel g�n�ral pour l'�criture efficace d'un rapport de bogues, par un utilisateur novice dans l'utilisation d'IssueZilla. Toutes les parties ne vous seront pas n�cessairement utilies pour le bogue que vous reportez.

Comment �crire un rapport de bogue efficace

Un bogue bien report� est un bug qui sera corrig� rapidement. Un bon bogue doit avoir deux qualit�s :

Reproductible. Si un ing�nieur ne le reproduit pas et n'arrive pas � prouver qu'il existe, c'est ing�nieur va s�rement l'estampiller comme 'INVALID/INVALIDE' ou WORKSFORME/NON REPRODUCTIBLE et passer � un autre bogue. Chaque d�tail que vous pouvez donner est une aide pr�cieuse
Sp�cifique. Le plus rapidement un ing�nieur peut isoler le bogue comme un probl�me sp�cifique, le plus rapidement �galement il pourra le r�gler. (Si un programmeur ou un testeur doit d�chiffrer un bogue, il passera plus de temps � maudire la personne qui a report� le bogue qu'� essayer de le fixer ou de le tester.)

Disons que l'application que vous testez est une feuille de calcul re�ue comme document attach�

Mauvais : ��Calc plante quand j'essaye d'ouvrir un document. Je pense qu'il contient un diagramme. Je suis sous Windows. Je pense que c'est un probl�me grave et que vous devriez le corriger maintenant. D'autre part vos ic�nes sont vraiment laides. Personne n'utilisera votre logiciel si vous conservez ces horribles ic�nes. Oh, ma grand-m�re a un probl�me avec le traitement de texte. Rien ne marche non plus. Bonne chance��.

Bon : ��Mon ordinateur se plante � chaque fois que j'essaie d'ouvrir la feuille de calcul attach�e en utilisant la version 10.13.00 sous Win NT 4.0 (Service Pack 5). J'ai �galement essay� sous Linux (RedHat 6.2) et j'ai reproduit le probl�me toujours en utilisant la version 10.13.00 pour Linux.
Lorsque j'ai supprim� le diagramme du document, j'ai pu ouvrir le document sans probl�me.��

Comment cr�er un rapport de bogue efficace dans IssueZilla

Pour reporter un bogue, vous devez �tre inscrit comme utilisateur OpenOffice.org. Pour s'enregistrer, c'est tr�s simple : cliquez sur le lien ��Join/S�incrire�� dans la barre de navigation et suivez les instructions. Cela ne prend que quelques minutes. Si vous �tes d�j� enregistr�, cliquez sur le lien ��My Issues/Mes Bogues�� sur la barre de navigation � gauche ou sur le lien ��Bugs ans Issues�� de la barre de navigation. La page suivante est une page explicative sur IssueZilla et indique �galement des liens utiles comme le lien d'interrogation de la base de donn�es (Query/Requ�te)

Rendez-vous sur la page de recherche IssueZilla Query Page pour d�terminer si le d�faut que vous avez constat� est un bogue connu et a d�j� �t� report� (si votre bogue est report� pour la 37e fois, vous allez plut�t emb�ter l'ing�nieur et un ing�nieur emb�t� est un ing�nieur qui r�soud moins de bogues !)

Assurez-vous que vous avez pu reproduire votre bogue en utilisant une version r�cente. N'h�sitez pas � faire appel � la mailing liste (http://fr.openoffice.org) pour que ce bogue soit reproduit par d'autres et sur d'autres syst�mes d'exploitation. (Les ing�nieurs sont souvent plus int�ress�s par des probl�mes affectant le code base sur lequel ils sont en train de travailler, plut�t que ceux ayant trait � un code source d�j� corrig� des centaines de fois et dont les bogues sont obsol�tes).

Si vous d�couvrez un nouveau bogue se rapportant � une version r�cente, entrez-le sur IssueZilla :

A partir de la page principale de IssueZilla, choisissez ��Enter a new issue/entrer un nouveau bogue��
S�lectionnez le component/composant (ou module) dans lequel vous avez trouv� le bogue
IssueZilla demande que vous indiquiez un module dans lequel vous avez rencontr� le bogue (si cette liste ne vous dit rien, cliquez sur le lien Component, qui vous conduira � une page descriptive des diff�rents �l�ments, afin que vous puissiez faire le meilleur choix)
Entrez votre adresse e-mail, votre mot de passe et appuyez sur le bouton ��Login�� (Si vous n'avez pas encore de mot de passe, laissez la case ��mot de passe�� vide et appuyez sur le bouton ��e-mail me a password/envoyez moi un mot de passe �. Vous recevrez alors, rapidement, un mail avec votre mot de passe.

Maintenant, remplissez le formulaire. Voici ce qu'il signifie :

O� avez-vous trouv� le bogue ?

Reporter/R�dacteur : Qui �crit ce rapport de bogue ?
C'est vous ! Pour entrer un bogue, vous devez �tre inscrit et �logu�.

Component/Composant : Dans quel module / composant / produit avez-vous trouv� ce bogue ?
Vous venez juste de remplir cela � la page pr�c�dente

Subcomponent/Sous-composant : Dans quel partie du composant principal avez-vous trouv� ce bogue ?
Vous avez g�n�ralement le choix entre UI (User Interface/Interface Utilisateur) et code. Code est utilis� uniquement si vous connaissez l'emplacement du bogue dans le code source, sinon choississez UI.

Version/Version : Dans quelle version du produit avez-vous trouv� le bogue ?
Donnez le num�ro de version, si possible.

Plateform/ Plateforme : Sur quel type de plateforme avez-vous rencontr� ce bogue ? (ex SUN, PC)
Si vous savez que ce bogue est reproductible sur toutes les plateformes, choisissez ��All/Toutes��. Sinon s�lectionnez la plateforme sur laquelle vous avez trouv� le bogue, ou ��Other/Autre�� si la plateforme n'est pas list�e.

OS/Syst�me d'exploitation : Sur quel syst�me d'exploitation avez vous trouv� le bogue ? (ex Linux, Windows NT)
Si vous savez que ce bogue est reproductible sur tous les syst�mes d'exploitation, choisissez ��All/Tous��. Sinon, s�lectionnez le syst�me sur lequel vous avez trouv� le bogue, ou ��Other/Autre�� si le syst�me n'est pas list�.

Quelle importance a ce bogue ?

Resolution Priority/Priorit� de r�solution : Quelle urgence de correction demande ce type de bogue ?
Le choix par d�faut est ��3��. 1 est le choix le plus urgent, 5 le moins urgent.

Issue Type/Type de bogue : Est-ce une defect/anomalie, enhancement/am�lioration, feature-request/fonction demand�e, task/t�che, patch/patch.
Par d�faut le choix dans la liste est ��defect/anomalie��. (Pour d�terminer le type de bogue le plus appropri�, cliquez le lien ��Issue Type/Type de bogues�� pour avoir acc�s � une description compl�te des choix propos�s ainsi qu'� la proc�dure de vote).

Qui va suivre ce bogue ?

Assigned to/Assign� � : Quel d�veloppeur va �tre responsable de la correction de ce bogue ?
IssueZilla va assigner automatiquement ce bogue � un ing�nieur par d�faut. Ce cadre de texte existe cependant pour vous permettre d'assigner directement la t�che � un ing�nieur diff�rent (pour voir la liste des ing�nieurs charg�s par d�faut des diff�rents �l�ments, cliquez sur le lien envoyant vers la liste des �l�ments ��Component��.

CC/Copie : Qui d'autre va recevoir un e-mail concernant les changements apport�s � ce bogue ?
Listez ici l'adresse compl�te des personnes qui doivent recevoir un e-mail concernant les changements apport�s � ce bogue. Vous pouvez entrer autant d'adresses que vous le d�sirez, ces adresses doivent �tre s�par�es par une virgule, et sans espaces entre les adresses.

Que pouvez-vous dire d'autre � l'ing�nieur au sujet de ce bogue ?

URL : Sur quelle URL avez-vous d�couvert ce bogue ?
Si vous avez rencontr� ce bogue � une adresse particuli�re, merci de la (ou les) indiquer.

Summary/Sommaire : Comment pourriez-vous d�crire ce bogue en 60 (ou moins) caract�res ?
Un bon sommaire doit permettre d'identifier de mani�re unique et rapide un rapport de bogue. Autrement, les ing�nieurs ne seront pas interpell�s par votre rapport et leur attention ne sera pas retenue lorsqu'ils liront leur 10 pages de rapport de bogues.

Un sommaire du style ��Echec � l'installation sur une RedHat 7.0, kernel 2.2.14�� est utile. ��Echec du logiciel�� ou ��Echec � l'installation�� repr�sentent des mauvaise exemples.

Description/Description : Que pouvez-vous dire d'autre � l'ing�nieur au sujet de ce bogue
Essayez de d�tailler le plus possible le diagnostique du probl�me. Une description pas � pas, pr�cise, est la meilleur fa�on de pratiquer.

Pour les crash, si vous pouvez apporter des indications additionnelles, cela peut aider :

Win 32 : Si vous recevez une erreur de Dr Watson, veuillez noter le type de crash et le module dans lequel l'application crash.
Unix : Merci d'indiquer une trace de la pile

Target Milestone/Date butoire. Consid�rez-le comme une date limite ; la cible est ��non d�termin頻 ou ��prochaine version�� -- pour la plupart des bogues, utilisez ��non d�termin頻.

Vous y �tes ! Apr�s avoir v�rifi� vos entr�es et possibles erreurs, pressez le bouton ��Commit/Envoyer��, et votre rapport de bogue va maintenant se retrouver dans la base de donn�es d'IssueZilla.

N'h�sitez pas � accompagner votre description d'un exemple ou d'un document attach�.

(Ce Guide a �t� �crit originellement pour Mozilla par Eli Godberg. Merci � Claudius Gayle, Peter Mock, Chris Pratt, Louis Surarez-Potts, Tom Schutter, et Chris Yeh pour leur contribution � ce document).