Skip to content

Instantly share code, notes, and snippets.

@tisseurdetoile
Forked from zakkak/.git-commit-template
Last active May 26, 2020 19:34
Show Gist options
  • Save tisseurdetoile/6b4e66631572f108ae571259b2b37ac6 to your computer and use it in GitHub Desktop.
Save tisseurdetoile/6b4e66631572f108ae571259b2b37ac6 to your computer and use it in GitHub Desktop.
This commit message template that helps you write great commit messages and enforce it across your team.
# <type(scope)> (Si appliqué, ce commit fera...) <sujet> (Max 72 char)
# |<---- C'est mieux en 50 charactères --->|<------------------->|
# Exemples:
# feat: automatisation des messages de commits
# feat(commit): automatisation des messages
# (Optionnel) Expliquer pourquoi ce changement est fait
# |<---- Essayer de vous limiter à un maximum de 72 characteres ---->|
# (Optionnel) Fournissez les liens/référence vers les tickets et autres resources
# Exemple: Github ticket #23
# --- FIN DU COMMIT ---
# Type peux être
# feat (nouvelles fonctionnalités)
# fix (correction de bug)
# refactor (refactorisation du code)
# style (formatage, oublie de point virgule, etc; pas de changement de code)
# doc (changements dans la documentation)
# test (ajout ou réecriture des tests; pas de changement sur le code de production)
# version (montée de version/création d'une release; pas de changement sur le code de production)
# build (Changement au niveau des dépendances (example de scope: npm, mvn gulp, broccoli)
# jdkX (Patch associé a un changement de version de jdk X est la version du jdk)
#
# --------------------
# N'oubliez pas de :
# * Utiliser une forme active dans la redaction du la ligne du sujet
# * Ne terminer pas la ligne du sujet avec un point
# * Separer le sujet et corps par une ligne blanche
# * Utiliser le corps du message pour expliquer quoi et pour-quoi pas comment
# * Utiliser les listes avec * et - sur plusieur lignes
# --------------------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment