Guide utilisation - Nommage des commits
Informations générales
- Date de création : 17/03/2026
- Dernière modification : 17/03/2026
- Mainteneur : Louis MEDO
Contexte
Ce guide d'utilisation présente les règles de nommage des commits sur le dépôt du projet. L'objectif est d'adopter un standard professionnel, basé sur la spécification Conventional Commits, pour rendre l'historique du projet lisible, propre et compréhensible par tous les collaborateurs. Un historique bien nommé permet de savoir immédiatement ce qui a été modifié sans avoir à analyser les fichiers un par un.
Matrice de nommage
La syntaxe d'un message de commit doit toujours respecter la structure suivante :
type: description de l'action.
Matrice présentant les différentes règles de nommage sur le dépôt :
| Nom du commit (Type) | Description |
|---|---|
docs: |
Ajout ou modification de texte. Utilisé pour la rédaction pure des fichiers Markdown. Exemple : docs: ajout de la procédure d'installation Debian |
feat: |
Nouvelle fonctionnalité. Utilisé lors de l'ajout d'un nouvel élément technique au site (comme un plugin MkDocs). Exemple : feat: ajout du module de recherche sur le site |
fix: |
Correction. Utilisé pour corriger une erreur, une coquille, ou réparer un lien mort dans un document. Exemple : fix: correction de l'adresse IP du serveur DNS |
style: |
Mise en forme. Utilisé pour les corrections de formatage (espaces, alignement de tableaux) sans impact sur le contenu. Exemple : style: alignement de la matrice des flux |
refactor: |
Restructuration. Utilisé lors du déplacement ou du renommage de fichiers/dossiers sans modifier l'information. Exemple : refactor: déplacement des schémas vers le dossier ressources |
chore: |
Maintenance. Utilisé pour les tâches invisibles pour le lecteur final (mise à jour de configuration). Exemple : chore: mise à jour du fichier mkdocs.yaml |