Rapporter les bogues

Avant de soumettre un nouveau rapport de bogue

  • Assurez-vous de pouvoir reproduire le bogue et identifier les étapes nécessaires pour le déclencher.
    Utilisez idéalement un nouveau fichier vide (qui pourra par la suite servir pour des tests), et essayez également de reproduire le bogue après avoir réinitialisé les préférences d'Inkscape (informations ici). Cela vous confirme que le problème est ce que vous pensez qu'il est et n'est pas lié à des réglages particuliers du programme. Si vous ne pouvez pas le reproduire pour vous-même, merci d'attendre de pouvoir isoler le problème avant de le rapporter.

    Parfois, des bogues qui se révèlent uniquement pour un fichier spécifique (non vide) sera intéressant pour les développeurs. Mais si vous êtes un débutant, commencez par discuter du problème avec des utilisateurs plus avancés (soit dans un forum, sur IRC ou sur la liste de diffusion), avant de créer un nouveau rapport de bogue. Les débutants peuvent souhaiter discuter d'un bogue potentiel avec d'autres utilisateurs avant de le rapporter. Plus d'informations ci-dessous.

  • Effectuez une recherche dans le traqueur de bogues, pour vous assurer que le bogue n'a pas déjà été rapporté.

    1. Dans l'ancien traqueur sur Launchpad :
      Il a été notre traqueur principal pendant des années, donc votre bogue y est potentiellement déjà listé. L'ancien rapport peut contenir plus d'informations que vous en possédez. Vérifiez si le problème est toujours présent dans la dernière version d'Inkscape. Si c'est le cas, aidez-nous en transférant le rapport sur GitLab, où nous traquons les bogues plus activement. Essayez de résumer les informations techniques du bogue de la meilleure façon possible. Gardez votre résumé concis et incluez un lien vers l'ancien rapport sur Launchpad.

    2. Traqueur sur GitLab (instructions et lien plus bas) :
      Assurez-vous formellement que le problème n'a pas déjà été rapporté ici avant de créer un nouveau rapport ou d'en transférer un depuis Launchpad. Si un rapport existe déjà, vous pouvez ajouter un nouveau commentaire au rapport existant avec les informations supplémentaires que vous possédez qui pourraient s'avérer utiles. Si vous voulez indiquer qu'un correctif est important pour vous, ajoutez un vote positif à la place, en utilisant les petites icônes de vote à droite de la description. (Évitez les commentaires style « Moi aussi ! » car ils rendront les informations techniques plus difficiles à discerner par les développeurs.) Si vous trouvez des rapports liés, qui pourraient aider les développeurs à corriger le bogue, vous nous aideriez grandement en les liant.
      Si finalement, vous créez un nouveau rapport, faites éventuellement attention à clarifier en quoi votre problème diffère de rapports existants.

Tout rapport de bogue doit contenir les informations suivantes

  • Une description précise du problème (c'est-à-dire concise et juste, mais contenant le plus de détails possible), incluant :

    1. des étapes à suivre qui permettent de reproduire le problème ;
    2. le comportement du programme que vous avez observé au terme de ces étapes ;
    3. le comportement du programme que vous souhaiteriez obtenir.

    Si vous souhaitez apprendre comment rédiger un « bon » rapport de bogue qui est le plus utile possible pour les développeurs, vous pouvez lire l'essai très profond sur Comment signaler efficacement un bogue par Simon Tatham, le créateur de PuTTY.

  • La version d'Inkscape que vous utilisez (depuis le menu : Aide > À propos d'Inkscape > regardez dans le coin en haut à droite ; par exemple : « Inkscape 0.92.3 (2405546, 2018-03-11) »).
    Si vous en avez une vue, listez également toutes les versions précédentes dans lequel le problème s'est produit, ainsi que toutes les versions dans lesquelles le problème n'était pas présent.

  • Le système d'exploitation que vous utilisez.

Les rapports de bogue doivent éventuellement contenir les éléments suivants, s'ils peuvent aider les développeurs à mieux comprendre le problème

  • Un fichier SVG de test qui contient tout le nécessaire pour faire apparaitre le problème mais rien d'autre (exemple minimal, cas de test minimal).

  • Le même fichier dans un autre format, dans le cas où le problème est lié à l'ouverture, à la sauvegarde, à l'importation ou à l'exportation depuis ou vers un autre format que le SVG.

  • Des captures d'écran, des vidéos ou des animations montrant un aperçu dynamique du problème, au cas où un fichier de test est soit inapproprié, soit insuffisant tout seul, pour présenter le problème. Des captures d'écran « avant, après » peuvent faire l'affaire, par exemple.

  • La langue de l'interface utilisateur d'Inkscape et du système d'exploitation (en particulier si le rapport est lié aux traductions, à des caractères spéciaux dans les documents et les noms de fichier, etc.).

  • La méthode d'installation et la version précise de l'installateur si le problème est lié à l'installation, à la mise à jour et/ou à l'exécution d'Inkscape.

Pourquoi toutes ces informations sont-elles importantes ?

Parce que les développeurs doivent pouvoir reproduire un problème avant de pouvoir le corriger. Dans Inkscape, les bogues peuvent être spécifiques à certaines versions ou systèmes d'exploitation (tout comme certaines combinaisons de ceux-ci), ou parfois à certaines langues. Tandis qu'un fichier test n'est pas forcément requis, ou pas toujours approprié ou utile, tout ce que les rapporteurs de bogues peuvent faire pour le rendre plus facile pour les développeurs aidera.

Tous les développeurs d'Inkscape sont des bénévoles. Ils et elles travaillent sur Inkscape dans leur temps libre, après leur journée de travail, leurs activités de loisir, leur temps en famille et leur temps personnel. Tout ce que les rapporteurs de bogues peuvent faire pour faciliter la correction du bogue et gagner du temps, augmentera la propension à la correction du bogue.

Autres responsabilités des rapporteurs de bogues

  • Restez disponible pour répondre aux requêtes des développeurs sur votre rapport.
    Vous recevrez une notification par courriel lorsque quelqu'un poste un commentaire, ou touche aux catégories, au classement ou au nivellement du rapport de bogue. On peut vous demander de clarifier quelque chose, de fournir d'autres fichiers, images ou documentation. Merci de vous souvenir que tout ce que vous pouvez faire pour aider les développeurs, assure une intervention réussie !
  • Soyez patient(e) et restez positif(ve).
    Lorsque vous rapportez un bogue, vous le faites parce que vous voulez que le bogue soit corrigé. Nous aussi ! Cependant, Inkscape est développé par des bénévoles dans leur temps libre, et du temps peut s'écouler avant que quelqu'un consulte finalement votre rapport (où que ce soit, entre quelques heures et des années). Dans tous les cas, essayez d'être le plus aimable et serviable possible (même si les développeurs peuvent se montrer obtus face à votre perspective — ;-) ), afin que les gens soient plus motivés à travailler sur le bogue et que le problème soit corrigé plus rapidement.

Créer le rapport de bogue, ou demander de nouvelles fonctionnalités

Merci de rapporter tous les bogues que vous constatez dans Inkscape dans le traqueur de bogues d'Inkscape sur GitLab.

Note : vous devez créer un compte sur GitLab pour pouvoir poser un commentaire ou créer un nouveau rapport.

Si vous êtes un utilisateur nouveau d'Inkscape ou même de niveau intermédiaire, cela peut être une bonne idée de poster le problème que vous rencontrez dans l'une des listes de diffusion électroniques (celle des développeurs ou de la communauté d'utilisateurs), ou sur l'un des forums style panneau d'affichage (liste sur cette page), pour débattre du problème plus directement. Une autre possibilité est de se rendre sur l'un des deux salons IRC. Souvent, des utilisateurs plus expérimentés pourront vous indiquer s'il s'agit d'un bogue connu ou un véritable bogue. Si c'est un bogue connu, vous pouvez aller le voir, et en apprendre plus sur lui. Dans la discussion, vous pourriez apprendre une autre manière d'obtenir ce que vous souhaitez.

De nouvelles fonctionnalités ou des éléments de liste de souhaits peuvent également être enregistrés sur le système de rapport de bogues. Encore une fois, si vous êtes un utilisateur novice d'Inkscape, vous pouvez discuter de votre idée sur une liste de diffusion électronique ou sur des forums, pour avoir un aperçu de la manière dont les développeurs vont le confronter à leur vision d'Inkscape, avant de soumettre votre rapport/requête.