Formations — 1 037 leçons en français

Accueil › Git & CI/CD › Les commits conventionnels

Les commits conventionnels

Hooks et qualité automatiqueavance

Une convention de message dont une machine peut déduire quelque chose.

type(portée)!: sujet

corps facultatif, expliquant le pourquoi

BREAKING CHANGE: ce qui casse et comment migrer

Exemples

feat(panier): appliquer les codes promotionnels au total
fix(auth): rejeter un jeton expiré depuis moins d'une seconde
docs: documenter la variable DATABASE_URL
refactor(commande): extraire le calcul de port
feat(api)!: renommer le champ « prix » en « prixHT »

Les types et leur effet

Type Signification Effet sur la version
feat nouvelle fonctionnalité mineure
fix correction de bogue corrective
docs, test, chore, refactor, style, perf, build, ci le reste aucun
n'importe lequel avec ! ou BREAKING CHANGE: rupture majeure

Pourquoi s'imposer ça

Pas pour la discipline. Parce que l'historique devient lisible par une machine : le numéro de version suivant et le journal des modifications se calculent, au lieu d'être rédigés à la main la veille d'une livraison — moment où ils sont toujours incomplets.

La règle à ne pas oublier

La convention ne tient pas toute seule. Branchée sur le hook commit-msg, elle est vérifiée à la saisie :

#!/bin/sh
# .githooks/commit-msg
grep -qE '^(feat|fix|docs|style|refactor|perf|test|build|ci|chore)(\([a-z0-9-]+\))?!?: .+' "$1" || {
  echo "Message non conforme. Exemple : fix(panier): corriger le total"
  exit 1
}

Les termes à connaître

Commit conventionnel

Convention de message dont la première ligne suit type(portée)!: sujet. Son intérêt n'est pas la discipline mais le fait qu'une machine puisse lire l'historique.

Type

Le premier mot du message. feat et fix ont un effet sur la version ; docs, chore, test, refactor, style, perf, build, ci n'en ont pas par défaut.

Portée

Entre parenthèses après le type, facultative. Elle nomme la partie du projet touchée — feat(panier) — et sert surtout à regrouper le journal des modifications.

Rupture

Un ! avant les deux-points, ou une ligne BREAKING CHANGE: dans le corps. C'est la seule information du message qui change le numéro de version majeure.

commitlint

Famille d'outils branchés sur le hook commit-msg qui refusent un message non conforme. Sans eux, la convention tient quelques semaines.

Sujet

Ce qui suit les deux-points. À l'impératif, sans point final, et il décrit l'effet du commit — pas les fichiers touchés.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.