Wiki

Rapport de bugs

Sun, 20 Aug 2017 18:08:32 +0200

Rapport de bugs
Auteur	j1.seth
Version actuelle	5.1
Date de sortie	2012
Compatibilité et téléchargement	PHPBoost 5.1 et PHPBoost 5.0
Démonstration	Rapport de bug

Module Rapport de bugs

Description : Le module "Rapport de bugs" vous permet de mettre en place un système de gestion des bugs présents sur votre site ou le suivi de l'évolution de n'importe quel produit en cours de développement.
Les utilisateurs peuvent rapporter les bugs détectés via un formulaire dynamiquement généré via l'administration du module. Les champs du formulaire sont définis selon les options choisies et configurées par l'administrateur du site.

Administration du module Rapport de bugs

Sat, 29 Apr 2017 13:24:27 +0200

Configuration

La page "configuration" du module "Rapport de bugs" se divise en plusieurs parties distinctes.

Paramétrage

La première de ces parties vous propose de régler la configuration globale du module.

Vous pouvez y définir:

Le nombre de bugs à afficher sur chaque page contenant une liste
La couleur de la ligne pour les bugs fermés
La couleur de la ligne pour les bugs rejetés
L'activation de la "feuille de route" (cette fonctionnalité, qui permet d'afficher la liste des bugs corrigés ou a corriger pour chaque version, n'est visible que si la liste des versions contient au moins une version)

Barre de progression

Vous pouvez choisir d'afficher une barre de progression sur la page d'un bug, qui évoluera selon l'état du bug.

Afficher la barre de progression des bugs : Si vous souhaitez ou non activer cette barre de progression
Pourcentage d'un nouveau bug : Pourcentage affiché à l'ouverture d'un bug
Pourcentage d'un bug En attente : Lorsque le bug a été mis à l'état 'En attente'
Pourcentage d'un bug Assigné : Lorsqu'un membre a été assigné à ce bug
Pourcentage d'un bug En cours : Bug à l'état 'En cours'
Pourcentage d'un bug Rejeté : Si le bug a été rejeté par l'équipe
Pourcentage d'un bug Réouvert : Lorsque le bug a été réouvert, suite à une raison quelquonque
Pourcentage d'un bug Corrigé : Lorsque le bug est corrigé

Alertes administrateur

Les alertes administrateur permettent d'alerter les administrateurs lorsqu'un bug est ouvert. Les alertes sont alors envoyées aux administrateurs, comme une alerte de mise à jour.

Activer les alertes administrateur : Si vous souhaitez ou non activer ces alertes
Niveau du bug pour déclencher l'alerte : Pour chaque niveau de bug (mineur, majeur, bloquant), vous pourrez définir si l'ouverture d'un tel bug provoque l'envoi d'une alerte
Action à la fermeture d'un bug : Action à accomplir lorsqu'un bug est fermé.

Statistiques

Les statistiques permettent d'afficher une page où se trouvent quelques statistiques du module, comme la répartition des bugs selon leur état (nouveau, corrigé, ..) et les membres qui ont posté le plus de bugs.

Activer les statistiques : Afficher ou non la page des stats dans la partie publique du module
Afficher la liste des membres qui ont posté le plus de bugs : Pour afficher la liste des utilisateurs ayant postés le plus de bugs, en dessous des statistiques
Nombre d'utilisateurs affichés : Si l'option précédente est activée, permet de définir le nombre d'utilisateurs à afficher

Messages privés

Il est possible d'envoyer des messages privés en fonction de certains événements. En voici la liste, dans l'ordre :

Activer ou non l'envoi de messages privés
Envoi d'un MP lorsque l'auteur ou un autre utilisateur modifie un bug
Si un bug est supprimé
Lors d'un commentaire sur un bug

Les autres options permettent respectivement d'envoyer un MP selon le changement d'état d'un bug.

Description par défaut des bugs

La section "Description des bugs" vous permet d'indiquer un gabarit si vous le souhaitez, des informations à entrer impérativement ou tout ce que vous voulez.

Types

Cette section permet de définir des "types de bug". A ne pas confondre avec les "Catégories de bugs". Le type de bugs permet, par défaut, de faire la distinction entre la détection d'une anomalie sur votre site ou bien la requête d'un membre pour une demande d'évolution de celui-ci. Là encore, c'est à vous de configurer le "bugtracker" pour qu'il réponde à vos besoins dans le cadre de votre utilisation.

Vous pouvez choisir de rendre le choix du type obligatoire via la section "type" obligatoire ? Oui / Non. Vous pouvez choisir de présélectionner le type par défaut dans le formulaire ou le supprimer en cliquant sur le bouton "Supprimer le type par défaut".

Les types ne s'affichent dans la liste des bugs qu'à partir du moment où ils contiennent au moins deux valeurs. Si la liste ne contient qu'une valeur, elle est automatiquement attribuée au bug. Si la liste ne contient aucune valeur, les types sont désactivés.

Enfin, vous avez la possibilité d'ajouter de nouveaux types via le champ visible sous le tableau des types.

Catégories

Cette section permet de définir les "catégories de bug". Cette section permet de définir la liste des catégories dans lesquelles classer les bugs.

L'utilisation des catégories est activée par défaut et le membre rapportant un bug doit obligatoirement sélectionner la catégorie à laquelle il se rapporte.

Vous pouvez choisir de rendre le choix de la catégorie obligatoire via la section "catégorie" obligatoire ? Oui / Non. Vous pouvez choisir de présélectionner la catégorie par défaut dans le formulaire ou la supprimer en cliquant sur le bouton "Supprimer la catégorie par défaut".

Les catégories ne s'affichent dans la liste des bugs qu'à partir du moment où elles contiennent au moins deux valeurs. Si la liste ne contient qu'une valeur, elle est automatiquement attribuée au bug. Si la liste ne contient aucune valeur, les catégories sont désactivées.

Toujours par défaut, les catégories proposées sont liées à l'utilisation même de PHPBoost. On y retrouve donc des catégories associées au noyau, aux modules, au graphisme, ou à l'installation du logiciel. Là encore vous avez la possibilité d'organiser les catégories de bugs en fonction de vos besoins personnels.

Enfin, vous avez la possibilité d'ajouter de nouvelles catégories via le champ visible sous le tableau des catégories.

Restreindre l'affichage des bugs

Dans la configuration du module Rapports de Bugs (bugtracker) une nouvelle option est proposée : "Restreindre l'affichage des bugs"

Elle interdit à un utilisateur qui n'a pas le profil "Modérateur" de voir les bugs qu'il n'a pas lui même déclaré.

De plus, après chaque contribution, l'auteur d'une déclaration de bug verra s'afficher un message de confirmation de la prise en compte de sa demande :

Niveaux

Par défaut, eh oui encore cette section n'est pas obligatoire. Elle vous permet de définir le degré d'importance d'un bug, selon qu'il s'agisse d'un bug mineur (peu important), majeur (très important) ou carrément bloquant (empêchant l'accès à une page/fonctionnalité du site).

Afin de favoriser la visibilité des bugs, vous pouvez définir pour chaque niveau, une couleur de fond associée.

Vous pouvez choisir de rendre le choix du niveau obligatoire via la section "niveau" obligatoire ? Oui / Non.

Vous pouvez choisir de présélectionner le niveau par défaut dans le formulaire ou la supprimer en cliquant sur le bouton "Supprimer le niveau par défaut".

Les niveaux ne s'affichent dans la liste des bugs qu'à partir du moment où elles contiennent au moins deux valeurs et que l'utilisateur a le droit de choisir le niveau (voir la partie autorisations). Si la liste ne contient qu'une valeur, elle est automatiquement attribuée au bug. Si la liste ne contient aucune valeur, les niveaux sont désactivés.

Sous le tableau, un champ vous permet d'ajouter de nouveaux niveaux et d'y associer la couleur de votre choix.

Priorités

La section "Priorités" vous permet, de la même manière que pour les niveaux et catégories de bugs, de définir les priorités liées aux bugs signalés.

Par défaut, cette section n'est pas obligatoire.

Vous pouvez choisir de rendre le choix du niveau obligatoire via la section "priorité" obligatoire ? Oui / Non. Vous pouvez choisir de présélectionner le niveau par défaut dans le formulaire ou la supprimer en cliquant sur le bouton "Supprimer la priorité par défaut".

Les priorités ne s'affichent dans la liste des bugs qu'à partir du moment où elles contiennent au moins deux valeurs et que l'utilisateur a le droit de choisir la priorité (voir la partie autorisations). Si la liste ne contient qu'une valeur, elle est automatiquement attribuée au bug. Si la liste ne contient aucune valeur, les priorités sont désactivées.

Sous le tableau, un champ vous permet d'ajouter de nouvelles priorités.

Versions

La section "Versions" vous permet, de définir dans quelle version le bug a été détecté et dans quelle version il va être corrigé.

Vous pouvez choisir de rendre le choix de la version obligatoire via la section "version" obligatoire ? Oui / Non. Vous pouvez choisir de présélectionner la version par défaut dans le formulaire ou la supprimer en cliquant sur le bouton "Supprimer la version par défaut".

Les versions ne s'affichent dans la liste des bugs qu'à partir du moment où elles contiennent au moins deux valeurs et qu'elles sont affichées dans la liste "détectée". Si la liste ne contient qu'une valeur, elle est automatiquement attribuée au bug. Si la liste ne contient aucune valeur, les versions sont désactivées et il n'est pas possible d'afficher la feuille de route pour chaque version.

Sous le tableau, un champ vous permet d'ajouter de nouvelles versions et de choisir si elles sont affichées dans la liste lors de la création d'un bug. Une version peut par exemple ne pas apparaître dans cette liste tant qu'elle n'est pas sortie, les personnes qui détectent un bug ne pourront donc pas la choisir. Une fois la version sortie, il faudra cocher la case correspondante pour l'afficher dans la liste.

Autorisations

A l'instar des autres modules et outils de configuration de PHPBoost, les autorisations liées au "Bugtracker" vous permettent de définir les droits de lecture / écriture / autorisations avancées (pour choisir le niveau et la priorité du bug) et modération de ces derniers.

Le fonctionnement du système d'autorisation reste inchangé. Un appui sur la touche "CTRL" et un clic sur les différents types d'utilisateurs vous permettent de choisir à qui vous attribuez les droits.

N'oubliez pas de valider le formulaire en cliquant sur le bouton "Modifier"

[align=center]

Utilisation du module Rapport de bugs

Sat, 14 May 2016 14:13:08 +0200

Une fois le module "rapport de bugs" activé et configuré, il vous faudra le rendre accessible aux membres ayant une autorisation d'accès. Pour cela, vous pouvez créer un lien direct vers l'URL

Code TEXT :

http://monsite.com/bugtracker/

dans un menu de liens par exemple.

Seuls les membres ayant les autorisations nécessaires pourront accéder au module.

Présentation du module

La page d'accueil du module se présente sous la forme d'un tableau à onglets.

Si toutes les options sont actives, le tableau affichera quatre onglets:

Bugs non-résolus
Bugs résolus
Feuille de route
Statistiques : affiche les statistiques

Le menu du module en haut à droite de la page permet de déclarer un nouveau rapport de bug.

L'onglet "Feuille de route" n'est pas forcément présent.

Bugs non résolus

Cet onglet présente la liste des bugs non encore résolus. On y trouve les colonnes suivantes:

ID -> affiche le numéro identifiant du bug sous forme de lien pointant vers la page détaillée de la description du bug
Titre -> Affiche l'intitulé du bug
Informations : Etat du bug et commentaires s'il y a lieu
Détecté le -> date de détection du bug
Actions -> affiche les icônes de gestion du bug: Rejeter le bug / Modifier le bug / Afficher l'historique du bug / Supprimer le bug

Chaque ligne possèède une couleur de fond qui est propre au niveau du bug.

La colonne "Actions" n'est affichée que si l'utilisateur a le droit de modération sur le module.

Selon la configuration définie, le tableau peut contenir des colonnes supplémentaires.

Les filtres

Pour chaque page de bugs, vous avez la possibilité de trier les bugs selon plusieurs éléments.

Pour cela, cliquez sur le bouton 'Filtres' présent au dessus du tableau :

Vous pouvez alors sélectionner plusieurs filtres selon la configuration du module afin de ne laisser apparaitre que ceux qui vous intéressent.

Si vous souhaitez retrouver rapidement ces éléments, le bugtracker vous propose d'enregistrer le filtre courant à l'aide de l'icône

En dessous des listes déroulantes sont affichées les filtres sauvegardés. CLiquez dessus pour sélectionner directement le filtre désiré.

Enfin, si vous souhaitez supprimer un filtre existant, cliquez simplement sur l'icône qui se trouve à coté.

Bugs résolus

L'onglet "bugs résolus" affiche un tableau assez similaire au précédent avec cependant quelques variantes. En effet, la colonne "état" dresse ici la liste des bugs corrigés et rejetés. On y trouve la date de correction dans la colonne "Corrigé le".

Chaque ligne possèède une couleur de fond qui est propre au niveau du bug.

La colonne "Actions" n'est affichée que si l'utilisateur a le droit de modération sur le module.

Feuille de route

L'onglet feuille de route liste les bugs corrigés pour chaque version. Cet onglet ne s'affiche que si chacunes des conditions suivantes sont remplies:

il existe au moins une version renseignée dans la section "version" de l'administration du module
l'option "afficher la feuille de route" est activée dans la section "configuration" de l'administration du module

La feuille de route pour une version comprend les bugs corrigés (ID barré) ou à corriger (ID non barré) pour celle-ci. Une liste déroulante positionnée au dessus du tableau vous permet de choisir la version à afficher.

Statistiques

Comme son nom l'indique, cet onglet présente les statistiques du module.

Parmi les informations listées on trouve :

Le nombre de bugs détectés
Le nombre de bugs corrigés (Cette section n'est disponible que s'il y a au moins un bug corrigé dans une version)
Le top 10 (ou nombre défini dans la configuration) des personnes ayant détecté des bugs avec le détail du nombre de bugs pour chaque participant, si cette option est activée.

Rapporter un bug

Après avoir cliqué sur le lien "Déclarer un bug" (cf "Présentation du module" en début d'article) PHPBoost affiche le formulaire d'ajout de bug.

Ce dernier vous propose de renseigner les informations nécessaires à la bonne compréhension du bug rapporté ainsi qu'à sa correction.

Vous aurez à renseigner:

Le titre du bug, permettant d'identifier rapidement le sujet dont il est question
La description, qui comprend certains champs pré-remplis (en fonction de la configuration du module) permettant de traiter le bug au mieux
La catégorie (si configurée) permettant de distinguer de quelle partie du site/objet provient le bug
Le niveau du bug, en fonction de son degré d'importance du bug
La priorité, permettant de savoir si le bug doit être résolu rapidement ou non (bien souvent en fonction du niveau d'importance du bug)
La version (si configurée) du script dans laquelle a été répertorié le bug
La possibilité de reproduction ou non, selon que le bug soit reproductible ou non
La méthode de reproduction du bug, s'il est reproductible

Après avoir validé le formulaire, le bug ainsi rapporté ira rejoindre le haut de la liste du tableau présentant les bugs résolus.

En fonction de la configuration du module, l'utilisateur pourra être averti par MP de :

L'ajout d'un commentaire à la suite du bug. Ces commentaires sont, la plupart du temps, rédigés par les développeurs qui pourraient nécessiter d'avantage d'informations pour solutionner le bug.
Le rejet du bug si ce dernier n'est pas considéré comme tel par les développeurs
La résolution du bug.

Chaque MP contient un lien pointant vers la page du bug avec sa présentation et les commentaires (s'il y en a) qui ont été postés sur la fiche en présence.