Commit Standard - SafeTel/Contribution GitHub Wiki

Commit Standard

Sur cette page, vous pouvez retrouver les références pour les topics des sections suivantes:


Commentaire de commit

Un commentaire de commit doit être explicite.

Invalid:

[FIX] crash on case 458

Valid:

[FIX] crash on login with invalid characters (case 458)

ADD commit

Ce commit est utilisé pour ajouter quelque chose au projet qui n'était pas éxistant avant.

Structure:

[ADD] // commentaire de votre commit

Exemple:

[ADD] cors dependencies

UP commit

Ce commit est utilisé pour update quelque chose qui était préalablement déjà présent.

Structure:

[UP] // commentaire de votre commit

Exemple:

[UP] action name NewRedditPost according to the documentation

FIX commit

Ce commit est utilisé pour fix quelque chose dans le projet.

Structure:

[FIX] // commentaire de votre commit

Exemple:

[FIX] build error, typo on docker's ports

HOTFIX commit

Ce commit est utilisé pour fix quelque chose qui compromets l'intégritée du projet.

ATTENTION: Ce type de commit est uniquement autorisé sur les branches désignées comme étant PROD (plus d'informations).

Structure:

[HOTFIX] // commentaire de votre commit

Example:

[HOTFIX] build error, missing dependencies