Ce fichier recense les conventions à adopter pour écrire un commit
Les commits doivent suivre la nommenclature suivante : (Type) Description
On peut en choisir un parmi :
- Style pour la pure mise en forme ;
- Content pur ajout de données (c'est-à-dire modification de contenu de variables ou de BDD)
- Refactor pour des changement de logique sans changement de fonctionnement ;
- Amend pour corriger un commit ;
- Enhance pour améliorer qqch qui existe déjà ;
- Feat nouvelle fonctionnalité ;
- Fix Correction de bug ;
- Fix #numero de bug Corrige le bug numéroté sur GitHub et ferme l'issue.
Elle décrit succintement ce que l'on a fait.
Les commits doivent respecter la nommenclature : (Style|Refactor|Amend|Enhance|Feature|(Fix (#[0-9]*)?)) Description
Exemple
- (Feat) add file upload
- (Fix) issue with login page