Skip to content

Normalisation des commits

Alexandre Javet edited this page Feb 15, 2021 · 6 revisions

Normalisation des commits

Format

verbe: message de commit

(Optionnel: Précisions du commit)

- Précision 1
- Précision 2
    - Sous-précision 2.1

Exemple

feat: Ajout du code incroyable

- Premier truc incroyable de ouf
- Vraiment incroyable ça dis donc
        - Voilà pourquoi c'est incroyable

OU

add: Rajout des commentaires

Verbes

Verbe Utilisé Verbe complet Utilisation
feat: feature Rajout d'une fonctionnalité au projet (DOIT FONCTIONNER)
add: addition Rajout de quelque lignes de code pour une fonctionnalité mineure
rem: removal Enlèvement de quelques lignes de code pour fonctionnalité mineure
wip: work in progress Ajout de code qui ne fonctionne pas encore, mais qui est en train d'être travaillé
ref: refactor Modification du code qui ne change pas la fonctionnalité du projet
fix: fix Correction d'un bug sur le projet
doc: documentation Rajout de documentation (Readme, etc...)
style: stylize Changement du code purement estéthique (Retours à la ligne, indentation, etc...)
perf: performance Rajout de code améliorant la performance du projet
build: build Ajout ou modifications de packages nécéssaires pour le projet (npm, yarn, etc...)
revert: revert Retour à un ancien commit

Ce format de commit doit de préférence être respecté, ceci permet d'avoir un historique plus propre et ou on se retrouve plus facilement. On peut également trouver des commits précis plus facilement.

Si des gens ne le respectent pas, ticket rouge 😛

Clone this wiki locally