Conventional Commits

Le format Conventional Commits est une convention de nommage des messages de commit qui vise à rendre l'historique des versions plus clair et compréhensible. Elle est couramment utilisée dans les projets collaboratifs pour harmoniser les contributions et faciliter l'automatisation de certaines tâches, comme la génération de changelogs et la gestion de version sémantique (semver).

Conventional CommitsConventional Commits

La doc officielle

Structure d'un Message Conventional Commit

Un message de commit suivant cette convention a la structure suivante :

<type>(<scope>): <description>

• <type> : Décrit le type de modification. Quelques types courants :

  • feat : Ajout d'une nouvelle fonctionnalité.

  • fix : Correction d'un bug.

  • docs : Modifications de documentation.

  • style : Changement de style (formatage, espaces, etc.) sans impact fonctionnel.

  • refactor : Changement de code sans ajout de fonctionnalités ni correction de bugs.

  • test : Ajout ou modification de tests.

  • chore : Tâches diverses (maintenance, configuration).

• <scope> (optionnel) : Indique la partie du projet concernée (module, fichier, composant).

• <description> : Brève description des modifications (environ 50 caractères).

Exemples de Messages Conventional Commits

feat(auth): add user login functionality
fix(api): handle null response on data fetch
docs(readme): update installation instructions
style(button): adjust padding for mobile view

Avantages de la Convention

1. Lisibilité accrue : Les messages de commit suivent une structure claire qui facilite la compréhension.

2. Génération automatique de changelog : En suivant ce format, on peut utiliser des outils pour générer automatiquement un changelog à partir de l'historique des commits.

3. Automatisation de la version sémantique : Avec des commits bien structurés, des outils comme Semantic Release peuvent déterminer automatiquement les versions majeures, mineures, ou patch en fonction des types de commits (feat pour une nouvelle version mineure, fix pour un patch, etc.).

En résumé, Conventional Commits favorise une communication claire, facilite la maintenance, et rend la gestion de version plus fluide et automatisable.