Rapporter un bug

From Documentation de la solution web de gestion OpenFlyers
Revision as of 22:03, 15 August 2010 by imported>Claratte (→‎Comment rapporter un bug)
Jump to navigation Jump to search

Introduction

Nous utilisons comme outil de "traceur de bugs" (ou Bug Tracking System).

Pour pouvoir éditer des informations, il faut d'abord vous identifier.

Lors de la création de votre compte, un mail vous est envoyé automatiquement et instantanément. Si vous ne le recevez pas, vérifiez qu'il n'a pas été mis de côté (voir supprimé) par un outil anti-spam attaché à votre messagerie. Enfin, si vous ne retrouvez pas le mail, envoyez-nous un mail pour demander une activation manuelle de votre compte en nous précisant l'identifiant que vous avez choisi pour la création du compte.

Nous sommes conscient que l'utilisation de cet outil nécessite un peu plus de temps pour rapporter une anomalie que l'envoie d'un mail. Mais pour l'équipe de développement OpenFlyers, c'est un véritable gain de temps qui permet ainsi d'être plus efficace et donc de limiter les coûts !

Comment rapporter un bug

Avant de rapporter un bug, prenez le temps d'effectuer les actions suivantes :

  • Vérifier que le bug n'est pas déjà rapporté.
  • Renseigner les items dès le début pour éviter l'envoi dans une rubrique non adaptée.
  • Choisir la bonne catégorie :
Intitulé Rubrique
Admin si cela touche la partie configuration/administration
Booking si cela touche la partie "cahier de réservations"
Flights Management si cela touche la partie "saisie des vols"
Accounting Management si cela touche la partie financière
Documentation si cela concerne des précisions sur la documentation
Update si cela touche l'utilitaire de changement de version
Translation si cela touche les traductions (phrase dans une mauvaise langue ou manquante dans une langue)
  • Choisissez la bonne version d'OpenFlyers sur laquelle vous avez constaté le bug. Le numéro de la version d'OF que vous utilisez se trouve en bas à gauche de la page d'identification d'OF.
    • 1.3.x
    • 2.0
    • 2.1beta
  • Résumé :
 Rédiger un intitulé explicite
  • Dans la description :
  • Si le bug est sur une version en ligne, indiquez sur quel espace client vous l'avez rencontré.
  • Si c'est une version en local, indiquez l'état dans laquelle est votre Base de données. Faire éventuellement une sauvegarde pour la figer dans un stade où le bug est reproductible.
La description doit être complète pour que les développeurs sachent identifier l'endroit du problème.
  • La nature "réelle" (non affichage, warning, etc.) du problème et sa manifestation.
  • Quelles sont les actions qui vous conduisent au bug
  • Joindre une copie d'écran est parfois plus explicite que de long discours. Ne pas en abuser, on ne cherche pas à documenter un bug pour le contourner mais à fournir des explications au développeur pour traitement.
  • En cours de traitement, utiliser les notes pour ajouter des informations, éviter les échanges par email parallèles.
  • Lorsque le bug est résolu vous recevrez un email d'information :
  • Merci de bien vouloir confirmer que le bug est résolu en fermant votre rapport de bug.
  • Si vous constatez que la solution ne correspond pas à votre description (totale ou partielle), relancez le sujet en le changeant d'état.
  • Par contre si vous détectez une nouvelle anomalie rédigez un nouveau rapport de bug.
La fermeture du Bug doit être effectuée par celui qui l'a émis.
En l'absence d'action de votre part dans un temps raisonnable le développeur ou un administrateur le fermera.

Faire une copie d'écran

Il est souvent utile de joindre une copie d'écran montrant le problème. Cela permet de montrer visuellement le problème et peut nous faire gagner un temps précieux à comprendre la description du problème.

Le site de www.commentcamarche.net présente une explication sur www.commentcamarche.net comment réaliser des captures d'écran.

Sous Windows, la combinaison de touches Alt + PrintScreen donne le meilleur résultat dans la plupart des cas : la fenêtre active est capturée et placée dans le presse papier. Il faut l'enregistrer avec un nom de fichier type jpg. Pour cela il existe une multitude de logiciels de traitement d'images. Ceci dépend des utilisations que vous souhaitez en faire :

  • le plus simple est l'utilitaire Paint inclut dans Windows mais il n'est pas très pratique
  • Gimp est très complet mais lourd pour juste faire des copies d'écran

FastStone est pratique si vous devez capturer une page qui est plus grande que l'écran ou une portion de l'écran et il permet de sauver la capture au format que l'on souhaite.

Description des états et de l'avancement de la résolution

Etats

Intitulé de l'état Description Qui devrait mettre cet état
nouveau nouveau bug, c'est l'état initial le rédacteur du bug
commentaire le bug nécessite plus d'informations, le rédacteur du bug devrait y préter attention un gestionnaire ou un développeur
accepté le bug a été lu mais n'est ni confirmé ni assigné un gestionnaire ou le développeur dont dépend le bug
confirmé le bug est confirmé et reproductible un gestionnaire ou un développeur
assigné le bug est assigné à un développeur un gestionnaire ou un développeur qui le prend en charge
résolu le bug devrait être résolu, en attente de la confirmation de sa résolution par le rédacteur du bug le développeur qui a corrigé le bug
fermé le bug est fermé le rédacteur initial du bug ou un gestionnaire ayant confirmé le bug

Résolutions

Intitulé de la résolution Description
ouvert bug ouvert en attente
résolu bug résolu d'après le développeur responsable
réouvert bug considéré comme toujours existant après correction
impossible à reproduire le bug rapporté n'arrive pas à être reproduit
impossible à corriger il n'y a pas de possibilité de corriger le bug
doublon le bug a déjà fait l'objet d'un rapport dans le BTS
pas un bug Ce n'est pas considéré comme un bug
suspendu Le bug est mis de côté
ne sera pas résolu Le bug est reconnu mais ne sera pas résolu

Comment fermer un rapport ?

Une fois qu'un rapport est positionné sur "résolu", voici comment procéder pour le fermer :

  • Cliquer sur le bouton "Rouvrir"
  • Mettre l'état du bug sur "fermer"

Traitement des bugs dans le BTS (pour les développeurs et gestionnaires)

  • Lorsqu'un bug est résolu il faut faire attention à le marquer comme tel dans la version en cours de modif (=donc normalement la future version publiée)
  • La fermeture du Bug doit être effectuée par celui qui l'a reporté.
  • En l'absence d'action de sa part dans un temps raisonnable un gestionnaire le fermera.

Suivez vos bugs

Respect des standards du web

Nous avons à coeur de respecter les standards du web dont notamment le standard XHTML 1.0 strict.

Pour vérifier la validité d'une page, il existe plusieurs outils.

Voici comment utiliser celui fourni par le W3C :

  • Afficher votre page à l'aide d'un navigateur (firefox ou internet explorer)
  • sauver la page seule sur votre disque dur
  • Allez sur la page du validator du W3C
  • Uploader le fichier sauvé sur le disque dur
  • constatez le résultat