|
|
|
Ce document vise à donner quelques clés pour utiliser Gitlab pour signaler des bugs sur Valpemap.
|
|
|
|
|
|
|
|
# 1. Généralités sur Gitlab et points d'attention
|
|
|
|
|
|
|
|
* Gitlab est un outil qui s'adresse initialement aux développeurs. La remontée de bugs est une de ses fonctionnalités, mais pas la seule. Il y a donc de nombreuses fonctionnalités que nous n'utiliserons pas.
|
|
|
|
|
|
|
|
* Sur Gitlab, ce que nous appelons bug sera signalé par une **issue**.
|
|
|
|
|
|
|
|
* Tous les textes que vous écrirez sur Gitlab seront interprétés en **Markdown** (cf. [ce lien](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) pour plus d'informations). Le texte peut ainsi être formaté, même si ça n'aura pas forcement grande utilité reporter les bugs. C'est en tout cas ce qui m'a permis de mettre en forme ce wiki, avec des titres des éléments en gras etc. La contrepartie est que certains formatage ne sont pas très intuitifs, notamment **le retour à la ligne**. En Markdown, pour s'assurer qu'un retour à la ligne sera pris en compte, il faut :
|
|
|
|
- soit ajouter deux espace à la fin de la ligne qui précède le retour à la ligne.
|
|
|
|
- soit laisser une ligne vide entre les deux lignes de texte (faire 2 sauts de ligne donc).
|
|
|
|
Si vous ne mettez qu'un saut de ligne et pas d'espaces à la fin de votre première ligne, la ligne du bas sera collée à la suite de la ligne du haut.
|
|
|
|
|
|
|
|
Lors de la rédaction de vos issues, vous pourrez aller dans l'onglet Preview pour prévisualiser le rendu de ce que vous avez écrit avant de l'envoyer.
|
|
|
|
|
|
|
|
# 2. Signaler un bug avec les issues
|
|
|
|
|
|
|
|
Pour signaler un bug, le seul onglet qui nous intéressera est **l'onglet Issues**, situé dans le volet de gauche de Gitlab
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dans l'onglet issues vous trouverez notamment les éléments suivants :
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Si vous avez un bug à signaler, deux cas de figure sont possibles :**
|
|
|
|
* **cas 1 : il s'agit d'un bug qui n'a pas encore été signalé --> il faut créer une nouvelle issue**
|
|
|
|
* **cas 2 : le bug a déjà été signalé --> vous pouvez commenter l'issue existante**
|
|
|
|
|
|
|
|
*En cours de rédaction...*
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
