Ce que vous écrivez aujourd’hui
Ouvrez l’historique d’un dépôt que vous tenez depuis quelques mois. Vous y trouverez probablement ceci.
a3f9c21 update
7d2e881 fix
e5b1c93 modifs
4b8a1f7 correction
9d2c604 wip
Cinq enregistrements, zéro information. Cet historique existe, il est daté, il est signé, et il ne sert à rien : pour savoir ce qu’ils contiennent, il faut ouvrir chacun d’eux.
L’ironie, c’est que vous avez fait le plus dur. Vous versionnez. Il ne manque que la phrase qui donne du sens, et elle coûte quinze secondes.
Ce que doit contenir un message
Un enregistrement répond déjà à trois questions : qui, quand, quoi. Le message répond à la quatrième, pourquoi, et c’est la seule qu’aucun outil ne pourra reconstituer à votre place.
La structure
Ligne de résumé, à l'impératif, sous 72 caractères
Corps facultatif, séparé par une ligne vide. Il explique le contexte
et la raison, pas la manipulation technique — celle-ci est visible
dans le diff.
Références en bas si nécessaire.
La ligne de résumé est ce que vous verrez dans git log --oneline, dans l’interface de la forge, et dans les notifications. C’est elle qui compte le plus.
Le corps n’est utile que quand l’intention n’est pas évidente. Ne vous forcez pas à en écrire un pour une correction de faute de frappe.
Trois règles pour la ligne de résumé
À l’impératif présent. « Corrige le filtre », pas « Correction du filtre » ni « J’ai corrigé le filtre ». Cela semble anecdotique ; en pratique, cela force à décrire une action plutôt qu’un état, et l’historique se lit comme une suite d’instructions cohérente.