👋 Bienvenue sur la convention pour les commits github/gitlab.
Le commit est souvent négligé auprès des jeunes développeurs.
Voici donc une convention pour que vous puissiez envoyer vos commits proprement.
Le "commit" doit être structuré comme suit :
<type>[champs des options] : <Description>
[option body]
[option footer]
build:
Changements qui affectent le système de compilation. (exemple: npm, broccoli, gulp ...)
ci:
Modifications de fichier et/ou scripts de configuration CI. (exemple: Travis, Circle, BrowserStack ...)
docs:
Modifications de la documentation uniquement.
new:
Une nouvelle fonctionnalité.
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 (exemple: espace blanc, formatage ...)
test:
Lors d'un test de commit.
security:
Lors d'une résolution de sécurité.
performance:
Lors d'une résolution de performance (optimisation inclus).
improuvement:
Lors d'une validation d'amélioration rétro-compatible.
breaking:
Lors d'une validation d'amélioration incompatible avec les versions antérieures.
improuvement:
Lors d'une validation d'amélioration rétro-compatible.
config:
Lors d'une validation de la configuration.
release:
Pour publier le commit.
update:
Utiliser lors de la mise à jour.
Le sujet contient une description écourté du changement:
- utiliser le présent: "changer" pas "changé" ni "changements"
- ne mettez pas la première lettre en majuscule
- pas de point (.) à la fin
- Augustin Ribreau - Developpeur - augustinribreau.com
Voir aussi la liste des sources ayant été utilisé.