Apprivoiser l'outil Reportbug de Debian

Un jour, je ne me souviens plus trop quand, j'ai voulu contribuer à Debian en apportant un complément sur un bug déjà rapporté. J'ai ouvert l'outil Reportbug (qui sert à signaler les bugs) et, à l'époque, ça m'avait semblé obscur. J'avais finalement opté pour la méthode par mail.

Cette semaine, sur ma Sid, j'ai trouvé un bug après une mise à jour. Comme j'utilise apt-listbug et que ce dernier ne m'a pas prévenue du problème, je suis allée vérifier si le bug était connu ou non sur la page dédiée de Debian. Il ne l'était pas. L'occasion pour moi de contribuer à nouveau (chic alors !).

Confortablement installée et sans éléments perturbateurs à l'horizon, cette fois le moment était idéal pour tenter de comprendre le fonctionnement de Reportbug.

Cet outil à l'avantage de mâcher une partie du boulot en renseignant automatiquement les informations qui concernent le paquet bogué, ses dépendances et autres données essentielles sur la version Debian utilisée.

En principe il est installé par défaut. Si ce n'est pas le cas on peut l'installer avec Apt ou Synaptic, le nom du paquet est reportbug - reportbug-gtk pour l'interface graphique (ou reportbug-ng si on préfére Qt à Gtk).

Bon, quand faut y aller, faut y aller ; que trépasse si je faibli ... j'ouvre Report bug.

Nota : Ici j'utilise la version avec interface graphique, c'est plus joli à l'œil et ça impressionne moins le novice.

reportbug-debian-1.png

La page d’accueil explique brièvement ce que fait Reportbug.
Suivant.

 

reportbug-debian-2.png

Ici on nous souhaite la bienvenue.

Toutes les traductions qui suivent (elles apparaisent sous forme de citations) ont été faites avec deepl.com qui donne de très bons résultats même quand il y a des mots un peu techniques :

Bienvenue sur reportbug ! Comme il semble que c'est la première fois que vous utilisez reportbug, nous configurons son comportement. Ces paramètres seront sauvegardés dans le fichier "/home/nom de votre utilisateur/.reportbugrc", que vous pourrez modifier ultérieurement.

Si vous êtes curieux vous pourrez allez voir à quoi ressemble ce fichier après la configuration.
Suivant.

 

reportbug-debian-3.png

Ici il faut choisir le mode opératoire qui sera utilisé par défaut pour rapporter les bugs.

On va faire au plus simple et opter pour le mode novice qui fait l'impasse sur les questions techniques.
Libre à vous de choisir un autre mode qui correspond mieux à vos connaissances, moi je suis novice. :p
Suivant.

 

reportbug-debian-4.png

Est-ce que reportbug aura souvent un accès direct à Internet ? (Vous devriez répondre oui à cette question à moins que vous ne sachiez ce que vous faites et que vous prévoyez vérifier si des déclarations en double ont été produites par un autre moyen.)

Si votre ordi est régulièrement connecté à internet (je pars du principe que c'est le cas de la majorité) répondez Oui.
Suivant.

 

reportbug-debian-5.png

Quel nom réel doit être utilisé pour l'envoi des rapports de bogues ?

Mettez votre nom ou un pseudo, c'est vous qui voyez ; ce nom apparaîtra publiquement sur le rapport de bug, tout le monde pourra le voir.

Suivant.

 

reportbug-debian-6.png

Laquelle de vos adresses e-mail doit être utilisée lors de l'envoi de rapports de bogues ? (Notez que cette adresse sera visible dans le système de suivi des bogues, vous pouvez donc utiliser une adresse webmail ou une autre adresse avec de bonnes capacités de filtrage du spam.)

Là aussi sachez que l'adresse mail que vous allez renseigner sera exposée sur internet donc utilisez de préférence une adresse dédiée ou un alias.
Suivant.

 

reportbug-debian-7.png

Avez-vous un "agent de transport de courrier" (MTA) comme Exim, Postfix ou SSMTP configuré sur cet ordinateur pour envoyer du courrier sur Internet ?

Répondez oui ou non selon votre cas. Si vous ne savez pas, allez au plus simple et répondez non.
Z'avez aussi le droit d'aller chercher sur internet ce que sont Exim et cie.
Suivant.

 

reportbug-debian-8.png

Veuillez entrer le nom de votre hôte SMTP. Habituellement, il s'appelle quelque chose comme "mail.exemple.org" ou "smtp.exemple.org". Si vous avez besoin d'utiliser un port différent de celui par défaut, utilisez le format alternatif <host>:<port>.
Appuyez simplement sur ENTRÉE si vous n'en avez pas ou si vous ne savez pas, et un hôte SMTP Debian sera donc utilisé.

Pour faire au plus simple, appuyez sur ENTRÉE pour utilisez le smtp de Debian pour envoyer le rapport.
Sinon renseignez votre hôte smtp avec, si besoin, le port à utiliser.
Suivant.

 

reportbug-debian-9.png

Veuillez entrer le nom de votre serveur proxy. Il ne devrait utiliser ce paramètre que si vous êtes derrière un pare-feu. L'argument PROXY doit être formaté en URL HTTP valide, incluant (si nécessaire) un numéro de port ; par exemple, http://192.168.1.1:3128/. Appuyez simplement sur ENTER si vous n'en avez pas ou ne savez pas.

Perso je n'ai pas de proxy, j'appuie sur ENTRÉE.
Si vous n'en avez pas non plus ou si vous ne savez pas faites comme moi.
Si vous avez un proxy renseignez-le.
Suivant.

 

reportbug-debian-10.png

Fichier de préférences par défaut écrit. Pour reconfigurer, réexécutez reportbug avec l'option "--configure".

Notez ici la commande qui permet de modifier la configuration du bousin, cette commande est à écrire dans un terminal mais vous ouvrira bien l'interface graphique ; je n'ai pas vu de moyen de faire les modifications en ouvrant directement l'interface graphique de Reportbug.

Voilà ! Il ne reste qu'à cliquer sur Appliquer.

Maintenant que Reportbug est configuré il se ferme, hé ho mais revient Léon j'ai pas fini !

Je ré-ouvre Reportbug.
Suivant

 

reportbug-debian-11.png

Veuillez entrer le nom du paquet dans lequel vous avez trouvé un problème, ou tapez 'autre' pour signaler un problème plus général. Si vous ne savez pas dans quel paquet se trouve le bogue, veuillez contacter debian-user@lists.debian.org pour obtenir de l'aide.

En saisissant quelques lettres, une liste de paquets susceptibles de correspondre à celui qu'on cherche apparaît, c'est pratique et ça permet d'éviter les fautes de frappe ou d'étourderie.

Si le paquet que vous sélectionnez n'est pas installé, reportbug le signalera mais n'empêchera pas de signaler un bug pour quelque chose qui n'est pas installé. Pratique si on utilise une autre machine pour signaler un bug rencontré sur un pc qui ne veut plus faire grand chose sauf buguer en boucle.
Suivant.

 

reportbug-debian-12.png

Ici on peut prendre connaissance de bugs déjà signalés, vérifier que celui que l'on souhaite signaler n'existe pas déjà. Si il existe déjà il est possible d'apporter un complément d'information. Cette étape nécessite un accès à internet et n’apparaît que si il y a des bugs déjà connus.

reportbug-debian-13.png

Exemple de consultation d'un bug depuis l'interface de Reportbug. On peut l'ouvrir dans un navigateur tel que Firefox pour le consulter en ligne (Open in browser) et / ou y répondre (Reply).
Suivant.

 

reportbug-debian-14.png

Décrivez brièvement le problème (max. 100 caractères autorisés). Ce sera l'objet du message de bogue, alors gardez le résumé aussi concis que possible, par exemple : "n'envoie pas d'e-mail" ou "ne commence pas avec l'option -q spécifiée" .

Alors attention ici on commence à rédiger le rapport de bug en lui donnant un titre (objet du message) ; il faut impérativement le faire en anglais.

Si vous n'êtes pas à l'aise voire ne pratiquez pas du tout cette langue, demandez de l'aide à vos proches, les amis, les voisins, les gens sur un forum etc ...
Une astuce quand on maîtrise mal une langue : faire des phrases les plus courtes possible avec des mots simples.

Suivant.

 

reportbug-debian-15.png

Comment évalueriez-vous la gravité de ce problème ou de ce rapport ?

Ici on demande d'indiquer le niveau de gravité du bug.

Important un bogue qui a un effet majeur sur l'utilisabilité d'un paquet, sans le rendre complètement inutilisable pour tout le monde.

Normal un bogue qui ne nuit pas à la convivialité du paquet ; par exemple, un problème avec une option ou un élément de menu particulier.

Mineur des choses mineures comme des fautes d'orthographe et d'autres erreurs cosmétiques mineures qui n'affectent pas la fonctionnalité de base de l'emballage.

Liste de souhaits suggestions et demandes de nouvelles fonctionnalités.

Oh mais on peut même suggérer des nouvelles fonctions ... dis Petit Debian Noël, tu ferais pas un truc pour faire les crêpes et le café ?

Suivant.

 

reportbug-debian-16.png

Cher Mainteneur,
*** Journaliste Rapporteur, veuillez envisager de répondre à ces questions, s'il y a lieu. ***
* Ce qui a conduit à la situation ?
* Qu'est-ce que vous avez fait (ou n'avez pas fait) exactement qui était efficace (ou inefficace) ?
* Quel a été le résultat de cette action ?
* Quel résultat attendais-tu à la place ?
*** Fin du gabarit - supprimer ces lignes du gabarit Fin du gabarit ***

Ici il faut rédiger une description du problème, les questions posées aident à structurer la bafouille. Tout ce qui est entre *** est à supprimer ; on garde bien sûr Dear Maintener pour la politesse.
Pour un maximum de précisions, on peut y recopier les messages d'erreurs affichés par le terminal ou trouvés dans un fichier de logs ; donner une solution si on en a trouvé une, etc ...

N'oublions pas de rester courtois même si le bug signifie la fin du monde pour nous, et d'ajouter un petit mot de fin du style Regards, thanks, ou autre.
Suivant.

 

reportbug-debian-17.png

Ici on arrive à l'étape de l'envoi. Avant de cliquer sur soumettre le rapport de bug par email (Submit the bug report via email) on a encore quelques possibilités comme Ne pas soumettre le rapport mais l'enregistrer dans un fichier temporaire ou Joindre un fichier, Ré-éditer le rapport de bug etc ...

Voilà, finalement ce n'est pas sorcier, il faut juste prendre un peu de temps au calme pour lire et comprendre ce qu'on fait. Reportbug est un outil bien fait, même pour les novices. L'usage de la langue anglaise est la seule difficulté qui peut rester pénalisante pour une partie des utilisateurs de Debian.