-
Notifications
You must be signed in to change notification settings - Fork 20
Conventions de nommage
| Format | Description | Exemples |
|---|---|---|
| [us_id]-[description] | Branche qui porte sur le développement d'une story | 123-creer-compte |
| [bugfix]-[description] | Branche qui porte sur la correction d'un bug | bugfix-timeout-ko |
| [cleanup]-[description] | Branche qui sert à du refactoring | cleanup-add-tests |
| [infra]-[description] | Branche contenant du code technico-technique | infra-backup-db |
| [doc]-[description] | Branche liée à de la documentation (code ou README) | doc-readme-live |
| [hotfix]-[version]-[description] | Branche de correction de bugs de production | hotfix-2.1.1-regression |
| [release]-[version] | Branche utilisée lors d'une mise en production | release-3.0.0 |
Le format à respecter est le suivant : [#<PR_ID>] [<TAG>] <DESCRIPTION> (US-<US_ID>)., ex : "[#123] [FEATURE] Création de compte (US-987)."
PR_ID correspond au numéro de la PR généré par GitHub. Pour l'obtenir il faut... créer une PR depuis une branche.
Le fait d'utiliser le PR_ID plutôt que le numéro de story – pour rappel, généré par Trello dans le board du Product Backlog – permet de naviguer en un clic jusqu'aux modifications de code associées.
| Nom | Usage |
|---|---|
| FEATURE | PR relative à une story |
| BUGFIX | PR relative à une correction d'un bug (hors itération) |
| CLEANUP | PR relative à du refactoring |
| INFRA | PR relative à du code technique / d'infra |
| DOC | PR relative à de la documentation |
La description de l'US doit être en français, car il s'agit d'un produit francophone et qu'on souhaite que les gens, même loin de l'informatique, s'intéressent à notre CHANGELOG.
US_ID correspond à l'identifiant unique de la story dans le Product Backlog, généré et géré par Trello.
Les messages de commit doivent être rédigés en anglais (décision d'équipe du 27/04/2017).