Convention code - Juliette3529/Timber-Wall-E GitHub Wiki
Branche de BUILD :
- dev/[issue-id] ou feature/[issue-id] -> pour dev de fonctionnalité
- fix/[issue-id] -> pour bug
Branche de TEST :
- test/[issue-id]
Branche de PROD :
- develop = préprod
- master = prod
On se basera sur la convention Angular.
Chaque commit est constitué d'un header, et optionnellement d'un body, sur le format suivant Le header a un format spécial qui comprend un type, une scope et un sujet :
<type>(<scope>): <subject>
<BLANK LINE>
<body>
Doit être l'un des suivants :
- build : Changements qui affectent le système de build ou les dépendances externes (exemples de scope : gulp, broccoli, npm)
- ci : modifications de nos fichiers de configuration et scripts CI (exemples de scopes : Circle, BrowserStack, SauceLabs)
- docs : Modifications de la documentation uniquement
- feat : Une nouvelle fonctionnalité ou son évolution/amélioration
- fix : Correction d'un bug
- perf : un changement de code qui améliore les performances
- refactor : Un changement de code qui ne corrige pas un bug et n'ajoute pas de fonctionnalité
- style : Changements qui n'affectent pas la signification du code (espace blanc, formatage, points-virgules manquants, etc.)
- test : Ajout des tests manquants ou correction des tests existants
Le scope est plus libre mais doit clairement identifier le sujet (package, sécurité, log, utilisateur, tâche, ...).
- Pour une tâche, on utilisera son id
#{issue_number}
-
(non recommendé) Si le commit touche plusieurs sujets, on utilisera la wildcard
*
Le sujet contient une description succincte du changement :
- utiliser l'impératif, au présent : "changement", pas "changé" ni "changements".
- ne pas mettre de majuscule à la première lettre
- pas de point (.) à la fin
Le body doit inclure la motivation du changement et la mettre en contraste avec le comportement antérieur