Rapporter un bug: Difference between revisions

From Documentation de la solution web de gestion OpenFlyers
Jump to navigation Jump to search
imported>Drpiquouze
m (Text replacement - "Fichier:" to "File:")
 
(74 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= Introduction =
[[File:BTS home.jpg|thumb]]


Nous utilisons comme outil de "traceur de bugs" (ou Bug Tracking System) [http://bts.openflyers.org/ Mantis].
__TOC__


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


Lors de la création de votre compte, un mail vous est envoyé. 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.
L'outil de gestion de tickets client d'OpenFlyers utilise le logiciel OpenProject disponible à l'adresse https://project.openflyers.com.


=Rapporter un bug dans Mantis (pour les testeurs/rapporteurs)=
Afin de pouvoir voir et créer un ticket, il est nécessaire de créer un compte. '''Ce compte est indépendant de votre accès à la plateforme OpenFlyers au gestionnaire client d'OpenFlyers'''.
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 des le débuts pour éviter l'envoi dans une rubrique non adaptée
*Choisissez la bonne catégorie :


{| {{prettytable}}
Nous sommes conscients que l'utilisation de cet outil nécessite un peu plus de temps pour rapporter une anomalie que l'envoi d'un email. 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.
!Intitulé!!Rubrique
 
|- 
=Créer son compte=
|Admin||si cela touche la partie configuration/administration
*Se rendre sur le gestionnaire de ticket à l'adresse https://project.openflyers.com.
|-
*En haut à droite, cliquer sur '''Connexion''', puis '''Créer un compte'''.
|Cahier des resa||si cela touche la partie "cahier de réservations"
*Remplir le formulaire d'inscription. Le mot de passe doit contenir au moins 10 caractères.
|-
 
|Gestions des vols|| si cela touche la partie "saisie des vols"
[[File:Inscription-BTS.jpg|400px]]
|-
|Gestions des comptes||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 (en effet nous filtrons et pouvons donc passer à côté d'un bug répertorié sous une mauvaise version). Le numéro de la version d'OF que vous utilisez se trouve en haut à gauche de la page d'accueil d'OF.
**1.2.x
**2.0alpha
**2.0


*Résumé :
Un email de confirmation est envoyé par le BTS.
  Rédiger un intitulé explicite comportant si possible le n° de référence du scénario correspondant (cf. [[script]])
*Aller sur la messagerie pour retrouver cet e-mail et cliquer sur le lien permettant d'activer le compte.
L'envoi de l'e-mail est instantané mais il est possible de devoir attendre plusieurs minutes avant qu'il n'apparaisse dans la messagerie du fait d'un traitement par le serveur de messagerie recevant l'email. Si l'email n'est pas reçu, vérifier qu'il n'a pas été mis de côté (voir supprimé) par un outil anti-spam attaché à la messagerie. Enfin, si l'e-mail n'est pas retrouvé, il faut envoyer un e-mail au support OpenFlyers de demande d'activation manuelle du compte en nous précisant l'identifiant que choisi pour sa création.
*Cliquer sur le lien contenu dans le message pour activer votre compte.
*Se connecter.


*Dans la description
=Comment rapporter un bug=
Si le bug est sur une version en ligne, indiquez sur quelle base vous avez testé.
*[[#Se-connecter|Se connecter]]
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 ou le bug est reproductible.
*Sur la page d'accueil, dans la case "Projets", cliquer sur '''OpenFlyers'''.
*Dans le menu de gauche, cliquer sur '''Lots de travaux''' (ou '''Work Packages''' en anglais).
*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.
*Cliquer sur le bouton vert '''Créer'''
Un formulaire s'affiche avec comme titre '''New PROBLEME'''
*Remplir les champs '''titre''', '''description''' et '''Order Id'''
:*Dans le champ '''titre''' :
::*Indiquer entre parenthèses sur quelle plateforme OpenFlyers le problème est rencontré suivi d'un titre synthétisant le problème (exemple : ''(ac-nasa) Impossible de se connecter'')
:*Dans le champ '''description''' :
::*Préciser l'identifiant de l'utilisateur concerné
::*La description doit être la plus complète possible pour que les développeurs puissent reproduire le problème.
::*La nature "réelle" (non affichage, alerte, etc.) du problème et sa manifestation.
::*Quelles sont les actions qui conduisent au bug sous la forme de fils d'Ariane (exemple : '''Admin > Utilisateurs > Utilisateurs''' puis icône '''Modifier la fiche utilisateur''')
::*Joindre une copie d'écran est parfois plus explicite que de longs discours. Ne pas en abuser, on ne cherche pas à documenter un bug pour le contourner mais à fournir des explications au développeur pour qu'il puisse le traiter.
:*Dans le champ '''Order Id''' :
::*Mettre la valeur 0
*Cliquer sur le bouton '''Enregistrer'''.


Le descriptif doit être  complet pour que les développeurs sachent identifier l'endroit du problème.
Remarques :
*La nature "réelle" (non affichage, warning, etc.) du problème et sa manifestation.  
*En cours de traitement, utiliser les notes pour ajouter des informations, éviter les échanges par email parallèles.
*Communiquer TOUS les éléments minimaux pour commencer à réfléchir au pourquoi du problème, c'est à dire :
*Lorsque le bug est résolu vous recevrez un email d'information :
**OS utilisé (Windows 98, Windows XP, Linux, UNIX, Jaguar, etc.)
:*Merci de bien vouloir confirmer que le bug est résolu en '''fermant votre rapport de bug'''.
**Navigateur utilisé (Safari, Internet Explorer, Netscape Navigator, Firefox, etc.)
:*Si vous constatez que la solution ne correspond pas à votre description (totale ou partielle), relancez le sujet en le changeant d'état.
**La version du navigateur.
:*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.


*Si vous utilisez une version d'OpenFlyers qui n'est pas hébergée par l'association OpenFlyers (si la version que vous utilisez est hébergée par l'association, alors son adresse internet est de la forme nomduclub.openflyers.org), merci de nous communiquer également les éléments suivants :
==Faire une copie d'écran==
**phpinfo() peut être utile pour pouvoir détecter un éventuel problème de configuration de votre serveur.
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.
**il serait souhaitable, pour épargner un temps précieux, de s'assurer avant de signaler un bug que tous les fichiers sont uploadés correctement (présents sur le serveur, modifications maîtrisées).
'''A noter que nous n'assurons pas le support pour les hébergeurs gratuits'''. En effet, ces derniers imposent souvent des limitations qui sont sans rapport avec les hébergeurs payants. Notre application fonctionne correctement sur un serveur Linux "standard" (avec quelques variantes possibles) mais avec des options qui peuvent parfois n'exister que sur des hébergeurs payants. La version 2.0 pourrait, par exemple, se révéler bien plus exigeante que la 1.2 au niveau des prérequis.
*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 échéanges par email parallèle.
Si le bug est sur une version  en ligne, indiquer sur quelle base vous avez testé.
Si c'est une version en local indiquer 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.


Le descriptif doit être complet pour que les développeurs sachent identifier l'endroit du problème.
Le site de [http://www.commentcamarche.net www.commentcamarche.net] présente une explication sur [http://www.commentcamarche.net/faq/398-capture-d-ecran-copie-d-ecran comment réaliser des captures d'écran].


Indiquer : votre système d'exploitation et le navigateur utilisé.
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 [http://www.commentcamarche.net/download/graphisme-9 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
*[http://www.gimp.org/ Gimp] est très complet mais lourd pour juste faire des copies d'écran


Joindre une copie d'écran est parfois plus explicite que de longs discours mais ne pas en abuser, on ne cherche pas à documenter un bug pour le contourner mais à fournir des explications au développeur pour traitement.
[http://www.faststone.org/ 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.
*En cours de traitement, utiliser les notes pour ajouter des informations.
*Lorsque le bug est résolu vous recevrez un email d'information.  Vous devez '''fermer vos bugs'''. Si vous constatez que la solution ne correspond pas à votre description (totale ou parielle), relancez le sujet en le changeant d'état. Par contre si vous détectez une nouvelle anomalie rédigez un nouveau 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.


=Description des états et de l'avancement de la résolution=
=Description des états et de l'avancement de la résolution=
Line 101: Line 99:
|impossible à corriger||il n'y a pas de possibilité de corriger le bug
|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 Mantis
|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
|pas un bug||Ce n'est pas considéré comme un bug
Line 109: Line 107:
|ne sera pas résolu||Le bug est reconnu mais ne sera pas résolu
|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 Mantis (pour les développeurs et gestionnaires)=
=Se connecter=
*Aller sur https://project.openflyers.com
*Cliquer en haut à droite sur le bouton '''Connexion'''
*Renseigner l'adresse l'email de connexion dans le champ '''Nom d'utilisateur'''
*Renseigner le champ '''Mot de passe'''
*Cliquer sur le bouton '''Connexion'''


=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)
*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é.
*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.
*En l'absence d'action de sa part dans un temps raisonnable un gestionnaire le fermera.
'''Suivez vos bugs'''
'''Suivez vos bugs'''


=Respect des standards du web=
=Interopérabilité=
Nous avons à coeur de respecter les standards du web dont notamment le standard xhtml 1.0 strict.
==JavaScript==
 
Les interactions dynamiques d'OpenFlyers nécessitent que JavaScript soit actif. Voici une page du support AdSense de Google qui présente [https://www.google.com/adsense/support/bin/answer.py?hl=fr&answer=12654 les différentes méthodes d'activation de JavaScript] en fonction du navigateur.
Pour vérifier la validité d'une page, il existe plusieurs outils.
 
Voici comment utiliser celui fourni par le [http://www.w3.org/ 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 [http://validator.w3.org/ validator] du W3C
*Uploader le fichier sauvé sur le disque dur
*constatez le résultat

Latest revision as of 17:28, 2 October 2024

BTS home.jpg

Introduction

L'outil de gestion de tickets client d'OpenFlyers utilise le logiciel OpenProject disponible à l'adresse https://project.openflyers.com.

Afin de pouvoir voir et créer un ticket, il est nécessaire de créer un compte. Ce compte est indépendant de votre accès à la plateforme OpenFlyers au gestionnaire client d'OpenFlyers.

Nous sommes conscients que l'utilisation de cet outil nécessite un peu plus de temps pour rapporter une anomalie que l'envoi d'un email. 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.

Créer son compte

  • Se rendre sur le gestionnaire de ticket à l'adresse https://project.openflyers.com.
  • En haut à droite, cliquer sur Connexion, puis Créer un compte.
  • Remplir le formulaire d'inscription. Le mot de passe doit contenir au moins 10 caractères.

Inscription BTS.jpg

Un email de confirmation est envoyé par le BTS.

  • Aller sur la messagerie pour retrouver cet e-mail et cliquer sur le lien permettant d'activer le compte.

L'envoi de l'e-mail est instantané mais il est possible de devoir attendre plusieurs minutes avant qu'il n'apparaisse dans la messagerie du fait d'un traitement par le serveur de messagerie recevant l'email. Si l'email n'est pas reçu, vérifier qu'il n'a pas été mis de côté (voir supprimé) par un outil anti-spam attaché à la messagerie. Enfin, si l'e-mail n'est pas retrouvé, il faut envoyer un e-mail au support OpenFlyers de demande d'activation manuelle du compte en nous précisant l'identifiant que choisi pour sa création.

  • Cliquer sur le lien contenu dans le message pour activer votre compte.
  • Se connecter.

Comment rapporter un bug

  • Se connecter
  • Sur la page d'accueil, dans la case "Projets", cliquer sur OpenFlyers.
  • Dans le menu de gauche, cliquer sur Lots de travaux (ou Work Packages en anglais).
  • 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.
  • Cliquer sur le bouton vert Créer

Un formulaire s'affiche avec comme titre New PROBLEME

  • Remplir les champs titre, description et Order Id
  • Dans le champ titre :
  • Indiquer entre parenthèses sur quelle plateforme OpenFlyers le problème est rencontré suivi d'un titre synthétisant le problème (exemple : (ac-nasa) Impossible de se connecter)
  • Dans le champ description :
  • Préciser l'identifiant de l'utilisateur concerné
  • La description doit être la plus complète possible pour que les développeurs puissent reproduire le problème.
  • La nature "réelle" (non affichage, alerte, etc.) du problème et sa manifestation.
  • Quelles sont les actions qui conduisent au bug sous la forme de fils d'Ariane (exemple : Admin > Utilisateurs > Utilisateurs puis icône Modifier la fiche utilisateur)
  • Joindre une copie d'écran est parfois plus explicite que de longs discours. Ne pas en abuser, on ne cherche pas à documenter un bug pour le contourner mais à fournir des explications au développeur pour qu'il puisse le traiter.
  • Dans le champ Order Id :
  • Mettre la valeur 0
  • Cliquer sur le bouton Enregistrer.

Remarques :

  • 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 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"

Se connecter

  • Aller sur https://project.openflyers.com
  • Cliquer en haut à droite sur le bouton Connexion
  • Renseigner l'adresse l'email de connexion dans le champ Nom d'utilisateur
  • Renseigner le champ Mot de passe
  • Cliquer sur le bouton Connexion

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

Interopérabilité

JavaScript

Les interactions dynamiques d'OpenFlyers nécessitent que JavaScript soit actif. Voici une page du support AdSense de Google qui présente les différentes méthodes d'activation de JavaScript en fonction du navigateur.

Retrieved from "https://doc4-fr.openflyers.com/index.php?title=Rapporter-un-bug&oldid=12906"