Rapporter un bogue, c’est rendre service aux développeurs. Ou plutôt, bien reporter un bogue, c’est rendre service aux développeurs. Voici une liste de conseils que nous donne Lunar pour rapporter utilement un bogue :
Prérequis (rien ne sert de courir…)
Avant de rédiger le rapport, il il y a plusieurs choses à faire :
“Est ce que j’hallucine ?”
Essayer de reproduire le bogue permet de s’assurer que l’erreur se produit bien toujours de la mème manière, qu’il y a effectivement un bogue et qu’il ne s’agit pas d’une fausse manip, et qu’on a bien cerné la problématique. Un bogue qu’on ne peut pas reproduire ne peut pas être corrigé.
Est-ce que ça n’a pas déjà été reporté ?
Autant c’est très utile de rapporter un bogue, autant c’est une perte de temps pour tout le monde de le rapporter en double. Il est nécessaire de consulter au préalable la liste des rapports de bogues existants, au cas où il soit déjà rapporté par quelqu’un. (attention aux versions de Debian et des logiciels, un bogue rapporté dans stable et pas dans unstable, ou inversement.)
Les bogues de Debian sont rendus publics et sont visibles sur les pages du bug tracking system Debian.
Pré-diagnostiquer la panne
Pour qu’il soit possible aux développeurs de corriger, il leur faut une description précise du problème. D’abord il faut connaître le nom du paquet contenant le logiciel causant la panne : grâce à dpkg -S
% dpkg -S nomdulogiciel
Ensuite il faut collecter des informations sur l’erreur. Il est nécessaire de bien décrire l’erreur pour que les développeurs puissent la corriger.
Il est bien utile par exemple de lancer dans un terminal un programme graphique pour savoir ce qui se passe quand il plante, et de copier-coller les erreurs significatives dans le rapport ; ou d’utiliser les outils catchsegv et strace (outils qui pourront aider à détecter l’erreur au lieu de simplement dire “ça segfault..”
Il est conseillé de lire les informations sur le bug tracking system disponibles sur le site web, pour savoir quelles options choisir, et bien formuler son mail.
Écrire son rapport
Enfin, on peut se mettre à la rédaction. Un rapport de bogue doit contenir un titre, le nom du paquet, les rapports se font par mail, ils sont rédigés en anglais correct. Ils sont lus par des humains bénévoles et grognons, il faut être poli (hihi^^), et pas baragouiner dans sa barbe.
reportbug et reportbug-ng (ce dernier est un outil graphique) sont des outils utiles à la bonne rédaction du rapport.
Un bogue a un degré de sévérité :
Les bogues critiques, graves et sérieux, doivent être nécessairement fermés avant le freeze de la prochaine version stable de Debian. Si le bogue du paquet n’est pas corrigé, le paquet peut ne pas apparaître dans la nouvelle version stable.
Donner les informations environnementales : quelle architecture, quels composants logiciels concernés (noyau, paquets..). reportbug et reportbug-ng collectent automatiquement ces informations pour vous.
Précisez dans quelles circonstances vous avez fait la découverte de l’erreur, décrivez le problème, ses conséquences directes et, éventuellement, si vous en avez trouvé un, son palliatif. Dites ce que vous cherchiez à faire au moment du bogue, décrivez ce qui ne marche pas précisemment.
- À ne pas faire : “Quand je veux lire un CD, ca ne marche pas.” (avec quel logiciel essayait-t-on de lire le CD, quelle erreur s’est produite précisément, etc ?)
