Les commits

Introduction

La spécification Conventional Commits est une convention légère qui s'applique aux messages de commit. Elle fournit un ensemble de règles simples pour créer un historique de commit explicite, ce qui facilite l'écriture d'outils automatisés. Cette convention s'aligne sur SemVer, en décrivant les fonctionnalités, les corrections et les changements majeurs apportés dans les messages de commit.

Le message de commit doit être structuré comme suit :

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Les préfixes

Le commit contient les éléments structurels suivants, afin de communiquer l'intention aux utilisateurs de vos sources :

Préfixes
Explication

fix

un commit de type fix corrige un bug dans votre base de code (ceci correspond à PATCH dans le versionnement sémantique).

feat

un commit de type feat introduit une nouvelle fonctionnalité dans la base de code (ceci correspond à MINOR dans le versionnement sémantique).

BREAKING CHANGE

un commit qui comporte le pied de page BREAKING CHANGE: ou qui ajoute un ! après le type/la portée introduit une modification majeure de l'API (correspondant à MAJOR dans le versionnement sémantique). Un BREAKING CHANGE peut faire partie de commits de tout type.

Les autres types de préfixes sont également autorisés (basé sur la convention Angular):

Préfixes
Explication

build

chore

ci

docs

style

refactor

perf

test

Des pieds de page autres que BREAKING CHANGE: peuvent être fournis et suivre une convention similaire au format git trailer.

Last updated