Fr:Guide de Bugzilla

From NeoWiki

Revision as of 20:28, 6 March 2008

Un guide pour soumettre et évaluer des bugs dans NeoOffice Bugzilla

J'ai trouvé un bug ou bien je souhaite une amélioration de NeoOffice. Que dois-je faire ?

Avant de rapporter un bug dans NeoOffice...

1. Assurez-vous que vous avez installé le dernier correctif ; allez ici http://www.neooffice.org/neojava/patch.php pour télécharger le dernier correctif. Nos développeurs bénévoles et doués corrigent des bugs constamment et votre bug peut avoir été déjà corrigé.
2. Regardez sur la page Guide de dépannage pour voir toutes les possibilités de dépannage et les solutions concernant le problème que vous rencontrez.
3. Désactivez ou désinstallez tous les "haxies", comme InputManagers, les "plugins" SIMBL, ou les haxies qui utilise Unsanity's Application Enhancer (APE).
4. Regardez si vous pouvez reproduire le bug (provoquez l'apparition du bug à plusieurs reprises) ; les bugs qui ne sont pas reproductibles sont très difficiles à corriger.
   1. Regardez si vous pouvez reproduire ce bug après un redémarrage de votre Mac.
   2. Regardez si vous pouvez reproduire ce bug "avec une nouvelle configuration" ; parfois votre configuration peut être détériorée et provoquer un bug. Déplacez votre répertoire ~/Library/Preferences/NeoOffice-2.2) à un autre emplacement et relancez NeoOffice.
   3. Si vous disposez de la version X11 d'OpenOffice.org, regardez si le bug est reproductible dans la version X11 correspondante (par ex., NeoOffice 2.2.1 équivaut à OpenOffice.org/X11 2.2.1) ; si c'est le cas, postez plutôt un rapport de bug à OpenOffice.org IssueZilla, car c'est un bug d'OpenOffice.org.
5. Si le problème persiste, signalez le bug, suivez les instructions ci-dessous.

Demandes de fonctionnalités supplémentaires et d'améliorations

Le Programme de nouvelles Fonctionnalités de NeoOffice a été lancé récemment pour permettre aux utilisateurs de proposer et de financer l'addition de nouvelles fonctionnalités à NeoOffice ou l'amélioration de fonctionnalités existantes. Voyez la page NeoOffice New Features Programm ainsi que le forum New Features Programm de Trinity pour plus de détails.

Corriger les bugs dans les fonctions d'OpenOffice.org sort du cadre de ce projet. De même, la plupart des améliorations doivent être implémentées dans le code partagé et multipalteforme d'OpenOffice.org et leur demande doit plutôt être faite dans OpenOffice.org IssueZilla.

Rapporter un bug dans NeoOffice.org Bugzilla

Si vous n'avez pas déjà un compte sur NeoOffice Bugzilla, vous devez en créer un avant de rapporter un bug.
N.B. Les comptes sur Bugzilla sont différents de tout autre compte que vous pouvez avoir sur NeoOffice (par ex. Early Access Program, les forums de trinity, ou ce wiki).

1. Avant de signaler un bug, cherchez si ce n'est pas un double afin d'être certain qu'il n'a pas été déjà signalé.
   1. Sélectionnez Query Bugs dans la page principale de Bugzilla.
   2. Sélectionnez NeoOffice dans le menu Project et entrez les termes à rechercher.
      • Ne rouvrez pas des bugs qui semblent similaires signalés dans des versions plus anciennes de NeoOffice (par ex., des bugs signalés dans NeoOffice/J 1.1 ou NeoOffice 1.2.2—tout bug ayant un numéro inférieur à 1000 ou clos avant Avril 2006, car l' interface de Bugzilla affichera incorrectement la valeur de la version pour des bugs anciens) ; dans presque tous les cas, le bug n'est pas le même, et ajouter des informations supplémentaires ne fera que rendre le problème plus confus. Au lieu de cela, choisissez Add a new Bug et signalez dans le nouveau rapport que votre bug semble similaire au bug nnnn qui a été signalé dans la version nn de NeoOffice.
      • Si vous trouvez un bug existant (Unconfirmed, Reproducible but not assigned, Assigned, ou Reopened) qui ressemble au bug que vous voulez signaler, vous pouvez vous ajouter à la liste CC pour être avertis des développements nouveaux et des correctifs à tester. Si le bug est Unconfirmed (ou quelquefois Reopened) et si vous avez des informations complémentaires qui peuvent aider à confirmer le bug (par ex., un moyen alternatif de le reproduire), n'hésitez pas à ajouter un commentaire contenant ces informations.
2. Quand vous signalez un a bug, n'incluez qu'un problème (bug) à la fois ; cela permet de suivre et de corriger les bugs plus facilement.
3. Soyez sûrs de sélectionner la version appropriée de Mac OS X et incluez le numéro de correctif (Patchlevel) de votre application NeoOffice.

   Ceci nous aide à déterminer si le bug existe seulement dans une version particulière de Mac OS X— comme c'est souvent le cas, les premières versions du 10.4 semblaient particulièrment "buggy"— et avec quel correctif le bug a commencé à apparaitre. Ne sélectionnez pas "All" comme version du système sauf si vous pouvez reproduire le bug sur Mac OS X 10.3.9 et Mac OS X 10.4.x PPC ou sur Mac OS X 10.4.x PPC et Mac OS X 10.4.x Intel.

   • Le numéro de correctif (Patchlevel) est indiqué dans la fenêtre "À propos de NeoOffice " accessible dans le menu NeoOffice; si vous n'utilisez pas le dernier correctif, on vous demandera de l'installer et votre bug pourra être fermé.
   • La version de Mac OS X est indiquée dans la fenêtre "À propos de ce Mac" accessible dans le menu Pomme.
4. Donnez un résumé bref mais expliquant votre bug, par exemple
   • Si la date ne s'affiche pas dans le pied de page, un résumé tel que "La date ne s'affiche pas dans le pied de page" est utile, alors que "Pied de page" ne l'est pas.
   • Si vous ne pouvez pas insérer de nouvelles colonnes dans Calc, un résumé tel que "Je ne peux pas insérer de nouvelles colonnes" est utile, alors que "Insérer des colonnes" ne l'est pas.
5. Indiquez de façon détaillée les étapes nécessaires pour reproduire (provoquer) le bug ; les développeurs en auront besoin pour déterminer ce qui provoque le bug afin de pouvoir le corriger.

   Notez que OpenOffice.org et donc NeoOffice est un énorme programme, et que le développeur ou le membre de l'équipe QA travaillant sur votre bug peut ne pas être familiarisé avec la partie du programme dans laquelle vous avez découvert le bug. Donc plus vous fournirez de détails, plus il y aura de chances que quelqu'un soit capable d'utiliser votre rapport de bug.

6. Attachez des documents illustrant le bug (captures d'écran, crash logs, exemples de documents, etc.) après avoir signalé le bug; le lien "Create New Attachment" n'est présent qu'aprés que le bug a été soumis.
   • Attachez une capture d'écran, si nécessaire.
   • Attachez le document qui pose problème, si nécessaire, ou envoyez-le par email à Patrick si c'est un document qui n'est pas destiné à être public.

     N.B. Attachez les documents à part (attacher un document efface les commentaires non encore soumis)

7. Si vous signalez un plantage ou un blocage (le disque qui tourne indéfiniment), attachez un 'crashlog' (compte rendu de plantage) ou un échantillon (ne faites pas un copier/coller dans les commentaires)
8. Ne modifiez pas les champs "Status" ou "Assigned To" ; leur modification entrainera toujours la perte de votre bug. Les développeurs de NeoOffice ou les membres de l'équipe de tri évalueront votre bug, essaieront de le reproduire, et vous demanderont souvent des informations complémentaires. Ensuite, le développeur ou le trieur attribuera aux champs "Status" et "Assigned To" les valeurs appropriées. (voir ci-dessous)

Obtenir un 'crashlog' ou un échantillon

Obtenir un 'crashlog' quand NeoOffice se plante

• Option A: l'application CrashReporter est-elle activée ?

  Mac OS X a une application très appréciable appelée CrashReporter qui produit des rapports de crash quand les applications plantent. Elle est activée par défaut sur Mac OS X.

  1. Lorsque la fenêtre de dialogue annonçant "L'application NeoOffice a quitté inopinément" (ou "L'application soffice.bin a quitté inopinément") apparait, cliquez sur le bouton "Soumettre un rapport...".
  2. Copiez la totalité du contenu de la fenêtre "Rapport de Crash", ouvrez l'application TextEdit ; dans la barre de menus choisissez Fchier puis Nouveau afin de créer un nouveau document. Dans la barre de menus choisissez Format puis Convertir au format Texte. Collez le texte dans ce nouveau document. Cliquez sur Enregister sous le titre crash_log.txt. (C'est un document simple texte en format .txt.)
  3. Une fois le fichier texte sauvegardé, vous pouvez fermer la fenêtre de dialogue Rapport de Crash.

     N.B. L'intitulé des fenêtres de dialogue varient selon les versions de Mac OS X.

  4. Attachez ce crashlog au bug que vous signalez.
• Option B: le moyen compliqué (vous avez probabement désactivé CrashReporter)
  1. Ouvrez l' application Console, située dans le sous-dossier Utilitaires du dossier Applications.
  2. Cliquez sur l'icône "Logs" de la barre d'outils si le panneau Logs n'est pas visible sur la gauche.
  3. Dans la liste des logs, sélectionnez "~/Library/Logs" puis "CrashReporter" et "soffice.bin.crash.log"
  4. Localisez l'entrée de log correspondant au plantage le plus récent. Ce devrait être l'une de celles situées en bas. Chaque entrée de log de plantage est séparée de la précédente par une ligne d'astérisques ; au début de chaque entrée figure une date.
  5. Sélectionnez l'entrée, depuis la ligne "Host name" jusqu'à la fin et collez-la dans un nouveau document texte (dans l'application TextEdit, créez un nouveau document et choisissez Convertir au format Texte dans le menu Format).

     N.B. Le format du crashlog varie selon les versions de Mac OS X.

  6. Attachez ce crashlog au bug que vous signalez.

Obtenir un échantillon quand NeoOffice se bloque (affiche le disque qui tourne)

1. Ne "forcez pas à quitter" NeoOffice
2. Ouvrez l'application Moniteur d'activité, située dans le sous-dossier Utilitaires du dossier Applications.
3. Quand vous le lancez, Moniteur d'activité, devrait afficher une fenêtre répertoriant les différentes "opérations" qui tournent sur votre Mac.
4. Sélectionnez NeoOffice dans cette liste.
5. Cliquez sur le bouton "Inspecter".
6. Dans la fenêtre qui s'ouvre, cliquez sur le bouton "Échantilloner" dans le coin inférieur gauche ; cela générera un "échantillon" qui aidera les développeurs à déterminer pourquoi NeoOffice s'est bloquée.
7. Lorsque l'échantillon est complet, enregistrez le fichier ; vous pouvez alors fermer la fenêtre d'échantillonnage et forcer NeoOffice à quitter.
8. Attachez l'échantillon sauvegardé au bug que vous signalez.

Comment obtenir un profil Shark

Dans certains cas, Shark peut se révéler très utile. Par exemple si un processus ralentit le programme ou empêche la saisie du texte au clavier. Si les développeurs vous demandent un profil Shark, vous pouvez utiliser la méthode suivante :

1. Installez les outils CHUD depuis [1].

2. Lancez NeoOffice.

3. Lancez /Developer/Applications/Performance Tools/Shark

• La fenêtre qui apparait propose les informations que vous voulez obtenir. Il faut choisir : "Time Profile" (c'est l'option par défaut), puis Process (pour isoler et capturer seulement celui de NeoOffice), et ensuite choisir soffice.bin dans le menu déroulant des processus à droite.

4. Revenez à NeoOffice et provoquez le problème (par ex. en écrivant des phrases très longues ou avec des caractères accentués…).

5. Retournez à Shark. Cliquez sur Start. Shark enregistre ce que l'application est en train de faire pendant 30 secondes (par défaut).

6. Revenez à NeoOffice et essayez de la maintenir dans le même état (c-à-d saisissant le texte lentement) autant que possible pendant 30 secondes. C'est plus facile si elle se bloque un moment,.

7. Attendez que Shark termine le processus. Une fenêtre apparait appelée Sample 1 - Time profile of soffice.bin". Gardez ce fichier et annexez-le au rapport de bug que vous avez posté dans Bugzilla.

8. Si plus de 30 secondes sont nécessaires pour reproduire le problème (ou si vous voulez donner plus d'information, c'est un échantillon statistique, donc plus il est important mieux c'est), allez dans Shark dans le menu Config, puis dans Show mini config Editor et augmentez la durée qui apparait dans le champ Time limit.

Lectures complémentaires relatives au rapport de bugs

Les documents suivants, écrits par d'autres auteurs, proposent des réflexions supplémentaires sur les "bonnes méthodes" générales pour signaler des bugs :

• How to manipulate me (or, Tuesday Whipper-Snapping) (Brent Simmons, auteur du plus populaire lecteur de fils de syndication (fils RSS par ex.) NetNewsWire)
• How to Report Bugs Effectively (Simon Tatham, professionnel et programmeur de logiciels gratuits ; plusieurs traductions)
• How To Ask Questions The Smart Way (Eric S. Raymond, défenseur de l'open source ; un document beaucoup plus long qui traite aussi des problèmes généraux du type "obtenir de l'aide et des réponses", avec aussi plusieurs traductions)

Cycle de vie d'un Bug

Cette section explique chacun des "états" dans lequel un bug peut se trouver dans Bugzilla et comment un bug passe d'un état à un autre. Les deux états "Status" et "Resolution" dans Bugzilla sont expliqués.

Unconfirmed (Non Confirmé)

Tous les bugs commencent avec un statut de "Unconfirmed" et une resolution définie par "None".

À partir du statut "Unconfirmed", les bugs accèdent habituellement au statut "Reproducible but not assigned" si ce sont des problèmes reproductibles spécifiques à NeoOffice, "Closed" car "Duplicate" si un autre bug relatif au même problème a déjà été signalé, ou "Closed" comme "OpenOffice.org bug" si le bug existe aussi dans la version équivalente d'OpenOffice.org/X11. Les bugs "Closed" en tant que "OpenOffice.org bug" devraient être signalés par le rapporteur dans OpenOffice.org IssueZilla pour que les développeurs d'OpenOffice.org responsables pour ce problème le corrige, et la personne qui clôt le bug devrait avertir le rapporteur avec cette information (ne pas traduire) :

Quelquefois les bugs "Unconfirmed" sont aussi "Closed" comme "Not a bug" (si une fonctionnalité se comporte comme elle le doit, même si ce n'est pas de la façon dont le rapporteur pense qu'elle devrait le faire), "Closed" car "Won't fix" (le plus souvent ce sont des bugs de Mac OS X ou Java, qui ne peuvent être corrigés que par Apple, ou des améliorations de foctionnalités), ou "Closed" car "Works for me" (si personne d'autre ne peut reproduire ce bug ou si les informations données sont insuffisantes pour en déterminer la cause). En 2005 et 2007, de nouvelles résolutions ont été ajoutées pour prendre en compte les bugs survenant dans le code externe non dérivé de celui d'OpenOffice.org, lorsque les informations sont insuffisantes ou lorsque le rapporteur ne répond pas. Voir la section Closed (Fermé) ci-dessous pour plus d'information sur la manière d'utiliser ces résolutions.

Duplicate (Double)

Lorsque des bugs sont "Closed" comme "Duplicate", le numéro du bug dupliqué est ajouté au champ "Add Dependency" du bug qui est clos, par ex., si le bug 1060 est un double du bug 1048, entrez 1048 dans le champ "Add Dependency" du bug 1060 lorsque vous lui attribuez le statut "Closed".

Certains bugs peuvent être des doubles d'autres bugs qui sont "Assigned", "Fixed" (si le rapporteur n'utilise pas la dernière version ou le dernier correctif), "New", ou "Closed" (toutes les résolutions sauf "Duplicate"; un bug ne peut pas être le double d'un double, le bug est donc signalé comme un double du bug original).

Si un bug est un double d'un autre bug "Unconfirmed", cette situation est parfois suffisante pour justifier le passage du premier bug au statut "Assigned"— mais voyez ci-dessous quelles propriétés supplémentaires un bug devrait avoir avant d'obtenir le statut "Assigned". Dans le cas où deux bugs "Unconfirmed" sont des doubles l'un de l'autre, habituellement c'est le bug le plus ancien qui a le statut "Assigned" et le nouveau est marqué comme double. Cependant, si le rapport du bug le plus récent est plus clair, si plus d'informations, de documents sont fournis, etc…, alors le statut "Assigned" peut être attribué au nouveau bug et le plus ancien clos comme double du nouveau.

Reproducible but not assigned (Reproductible mais non assigné)

Ce statut (anciennement "New") est attribué aux bugs qui ont été reproduits par un membre de l'éqipe de triage. En général les bugs nécessitent un ensemble clair d'instructions pour reproduire le problème ainsi que de la "documentation" (captures d'écran, exemple de deocument, crashlog de Mac OS X ou échantillon, etc) avant de passer du statut de "Unconfirmed" au statut de "Reproductible but not assigned". Les développeurs consultent ensuite cette liste et s'assigneront les bugs à eux-mêmes selon le temps qu'ils peuvent consacrer à la correction des bugs en donnant la priorité aux bugs les plus critiques.

Ce statut est aussi attribué aux bugs que les développeurs ont l'intention de corriger mais qu'ils ne peuvent pas corriger immédiatement pour une raison ou une autre ; à ces bugs est attribuée la résolution "Deferred".

Souvent des bugs se voient attribuer ce statut ("Reproductible but not assigned" avec la résolution "Deferred") à cause de problèmes dans les logiciels sous-jacents (Mac OS X ou Java), dont nous savons qu'ils seront corrigés dans un version future de ces logiciels et seront peut-être corrigés lorsque les utilisateurs ou NeoOffice passeront à la nouvelle version.

Assigned (Assigné)

Les bugs sur lesquels un développeur de NeoOffice travaille activement ont le statut "Assigned", et le champ "Assigned To" contient l'adresse email du développeur qui travaille dessus.

La plupart des bugs "Assigned" ont leur statut changé en "Resolved" avec une résolution "Fixed", mais les bugs qui ne peuvent pas être corrigés pour le moment, ou qui peuvent l'être mais ne sont pas prioritaires et sur lesquels on ne travaille pas immédiatement, ont comme statut "Reproducible but not assigned" ( Reproductible mais non assigné" (anciennement "New") avec une résolution "Deferred". Les bugs "Assigned" peuvent aussi être changés en "Closed" car "Not a bug" ou "Closed" car "Won't fix" après que le développeur a étudié le problème et déterminé qu'il résidait ailleurs ou ne pouvait pas être corrigé.

Les bugs "Assigned" qu'un développeur a corrigés gardent souvent le statut "Assigned" (récemment "Assigned" avec comme résolution "Fixed" pour qu'ils ressortent mieux dans la longue liste "Assigned" ) jusqu'à ce que la correction apparaisse dans un correctif officiel ; à ce moment-là leur statut est changé en "Resolved" et la résolution en "Fixed" (et, une fois que la correction est intégrée dans une nouvelle version binaire, le statut est modifié en "Closed" et la résolution en "Fixed") ; dans tous les cas, seuls les développeurs devraient modifier le statut ou la résolution de bugs qui sont "Assigned" ou "Resolved".

Resolved (Résolu)

Les bugs qui sont corrigés sont "Resolved" en tant que "Fixed" une fois que le développeur a codé une solution qui corrige le bug et publié un correctif ("patch") officiel. Si un correctif ne corrige pas un bug, celui-ci devient "Reopened" ; une fois que le correctif a été inclus dans une version complète téléchargeable de NeoOffice (une "release", telle que NeoOffice 2.1), le bug est "Closed". (Seul le développeur de la version devrait changer le statut d'un bug de "Resolved Fixed" en "Closed Fixed" ; cela garantit que la correction est intégrée à la nouvelle version et qu'aucun bug n'a été oublié.)

Reopened (Rouvert)

S'il apparaît qu'un bug qui était "Resolved" comme "Fixed" n'a pas été corrigé par un patch, le rapporteur du bug devrait changer le statut du bug en "Reopened" et remettre la résolution à "None". De même, si un bug qui était marqué "Closed" dans une certaine version de NeoOffice réapparait dans une version postérieure de NeoOffice il doit, lui aussi, passer à "Reopened" et "None".

Si un bug qui était "Closed" car "Works for me" est encore présent et si le rapporteur a de nouvelles informations ou un meilleur processus pour le reproduire, il devrait aussi être changé en "Reopened" et "None" (théoriquement il devrait être ramené au statut "Unconfirmed" et "None" jusqu'à ce que quelqu'un puisse reproduire le bug, mais notre bugzilla est "manuel" et ne dispose pas de la fonction "automatique" nécessaire).

Closed (Fermé)

"Closed" est le statut final de tous les bugs dans NeoOffice Bugzilla. les bugs corrigés et dont la correction est intégrée dans une version complète de NeoOffice sont marqués "Closed" et "Fixed".

Les bugs qui sont marqués "Closed" sans avoir été corrigés ont l'une des résolutions suivantes :

• "Closed" comme "Duplicate", si un autre bug concernant le même problème a déjà été signalé ; Regardez la sous-section de Duplicate sous "Unconfirmed" pour plus d'information
• "Closed" comme "OpenOffice.org bug", si le bug existe aussi dans la version équivalente d'OpenOffice.org/X11

  Les rapporteurs devraient être invités à signaler le bug dans [Issuezilla d'OpenOffice.org] car les développeurs n'ont pas le temps de transférer tous ces bugs à OpenOffice.org.

• "Closed" comme "Not a bug", si la fonctionnalité est conforme à ce qu'elle doit être, même si cela ne correspond pas aux attentes du rapporteur, ou si le bug est provoqué par un logiciel d'une tierce partie (autre que les logiciels spécifiques qui ont des résolutions prévues dans Bugzilla, par ex. "Mac OS X bug").
• "Closed" comme "Won't fix", habituellement lorsque le bug est en fait un bug de Mac OS X ou Java, qui ne peut être corrigé que par Apple, ou des bugs qui nécessitent un fonctionnement non souhaité par les développeurs ou l'utilisateur de base
• NOUVEAU "Closed" comme "Mac OS X bug", si le problème est dû à un bug (ou une fonctionnalité) de Mac OS X.
• NOUVEAU "Closed" comme "ooo-build bug", si le problème est dû à un bug (ou une fonctionnalité) du code intégré depuis le projet ooo-build (Excel VBA macros, Calc Solver).
• NOUVEAU "Closed" comme "odf-converter bug", si le problème est dû à un bug (ou une fonctionnalité) du code intégré depuis le projet odf-converter (MS OpenXML import/export).
• NOUVEAU "Closed" "Insufficient info", si le problème ne peut pas être reproduit à l'aide des commentaires fournis par le rapporteur et si une relance du rapporteur n'a pas eu d'effet.
• "Closed" comme "Works for me", si personne ne peut reproduire le bug ou si quelque chose qui semblait être un bug semble soudain résolu sans qu'une correction ait été effectivement effectuée par les développeurs de NeoOffice.

Other open source project bug (Bug d'un autre projet open source)

Les bugs occasionnés par le code inclus dans NeoOffice depuis un autre projet open source auront ce statut, et le champ "Resolution" affichera le nom du projet open source cause de ce bug.

"Other open source project bug" devrait toujours avoir un lien vers le bug signalé dans l'autre projet open source. Si cet autre projet corrige ce bug, un développeur se l'assignera à lui-même et son statut deviendra "Assigned".

Diagramme

Le diagramme suivant présente une illustration graphique du cycle de vie d'un bug. N.B. Un certain nombre de résolutions notées NOUVEAU dans ce qui précède n'apparaissent pas dans ce diagramme