Projet GNOME pour FreeBSD : rapporter un bug
1. Quoi rapporter ?
La premi�re r�gle est : rapportez autant d'informations que vous pouvez. M�me s'il y a des informations inutiles les d�veloppeurs pourront facilement les �liminer. Au contraire, la situation est bien pire lorsqu'il n'y a pas assez d'informations pour d�couvrir ou reproduire le probl�me - dans ce cas, les d�veloppeurs devront perdre du temps � deviner et/ou demander des pr�cisions � l'auteur du rapport de bug.
Il y a plein d'exemples de rapports de bugs totalement inutiles, du genre "H�, le port de gnomebidule est cass�. J'utilise FreeBSD-X.Y. Corrigez svp." Inutile de dire que de tels rapports sont juste un gaspillage de votre temps, du temps du d�veloppeur concern� et de bande passante. Au strict minimum, le rapport doit inclure les informations suivantes :
La version exacte du syst�me d'exploitation (habituellement le r�sultat de uname -a).
La liste de tous les paquetages install�s sur votre syst�me.
Votre environnement (le r�sultat de /usr/bin/env).
Si vous faites une compilation � partir des ports, la date approximative o� vous avez mis � jour les ports.
Des informations sp�cifiques � chaque type d'erreur : le log complet de la compilation dans le cas o� la compilation d'un port est cass�, le contenu de la pile dans le cas d'un core dump, une description d�taill�e du probl�me lorsque cela concerne une application, etc. Essayez de vous mettre � la place du d�veloppeur et, pour chaque cas particulier, �valuez quelles informations peuvent �tre n�cessaires pour qu'il puisse trouver la source du probl�me. Ne pensez pas que les d�veloppeurs connaissent d�j� tout du probl�me et qu'ils sont juste trop paresseux pour le corriger.
Par ailleurs, essayez de r�pondre aux questions suivantes :
- Quel est exactement le probl�me ? : Expliquez le probl�me aussi clairement et pr�cis�ment que possible. Essayez de limiter la description du probl�me � une ou deux phrases cl�s.
- O� survient le probl�me ? : Dites si le probl�me intervient lors de la compilation, de l'installation, ou de l'ex�cution. D�crivez �galement la machine sur laquelle survient le probl�me (peut-�tre en avez-vous plusieurs) et avec quelle locale (i.e. quelle valeur de la valeur d'environnement LANG).
- Quand le probl�me est-il survenu pour la premi�re fois ? : Essayez de d�terminer quand le probl�me a commenc� � appara�tre. Si �a n'a jamais march� ou que vous avez toujours eu un probl�me, dites le �galement. Dites aussi quand le probl�me a �t� observ� pour la derni�re fois, et, le cas �ch�ant, quand les choses ont bien march� pour la derni�re fois.
- Quelle est l'importance du probl�me ? : Expliquez si les choses empirent, si elles s'am�liorent, ou si elles restent les m�mes. Nous avons conscience que beaucoup de probl�mes ne sont que des probl�mes, mais ce genre d'information peut s'av�rer utile dans certains cas.
Tenez vous pr�t � r�pondre � des questions suppl�mentaires. Bien souvent, les d�veloppeurs ne peuvent r�soudre un probl�me ou m�me en faire le diagnostique tout de suite. Donc, montrez vous compr�hensif lorsqu'on vous demandera de fournir d'autres informations.
Si vous avez une solution ou un moyen de contourner le probl�me, mettez le �galement dans votre rapport, m�me si vous n'�tes pas certain que cette solution est correcte. Si elle ne l'est pas, elle peut tout de m�me donner au d�veloppeur des id�es et lui faire gagner du temps.
2. O� envoyer le rapport ?
Avant de rapporter un bug, ou m�me d'envoyer un message sur la liste, faites une recherche dans les archives de la liste de diffusion GNOME pour FreeBSD pour voir s'il n'a pas d�j� �t� rapport�. La plupart des probl�mes rapport�s sur les listes de diffusion sont d�j� connus et, en faisant une recherche, vous pouvez trouver la solution � votre probl�me beaucoup plus rapidement.
Une fois que vous �tes certain qu'il s'agit d'un probl�me nouveau, il y a plusieurs mani�res de rapporter un bug concernant GNOME sous FreeBSD : vous pouvez envoyer un rapport sur la liste de diffusion freebsd-gnome, remplir un rapport de probl�me avec le syst�me de rapport de bug FreeBSD, envoyer votre rapport aux d�veloppeurs GNOME concern�s via leur syst�me de gestion de bug ou utiliser une combinaison de ces diff�rentes m�thodes.
Il est impossible de d�finir des r�gles qui vous indiqueront clairement dans tous les cas o� envoyer votre rapport - utilisez votre bon sens. Voici cependant quelques principes g�n�raux :
Si le probl�me est sp�cifique � FreeBSD et temporaire (e.g. un checksum incorrect, un patch qui �choue, une erreur de syntaxe dans le Makefile du port, etc.) alors envoyez le rapport � la liste de diffusion freebsd-gnome.
Si le probl�me est clairement non sp�cifique � FreeBSD et que vous n'avez pas de solution disponible alors envoyez le rapport directement aux d�veloppeurs du logiciel (pour la plupart des composants du noyau de GNOME cela signifie que vous devrez utiliser leur syst�me de gestion de bug "Bugzilla").
Si le probl�me n'est pas sp�cifique � FreeBSD mais assez s�rieux et que vous avez une solution disponible alors envoyez le rapport � la fois � FreeBSD et au syst�me de gestion de bug des auteurs, de fa�on � ce que le port concern� soit corrig� et que les autres utilisateurs FreeBSD puissent b�neficier de votre solution sans avoir � attendre la sortie d'une nouvelle version du logiciel.