Message de commit
Étapes
- Exécutez
git diff --staged pour voir ce qui sera commité. Si rien n'est indexé, dites-le et demandez s'il faut tout indexer (git add -A) ou des fichiers spécifiques. Ne jamais commiter du travail non indexé sans demander.
- Exécutez
git log --oneline -15 et adaptez le style que vous voyez : Conventional Commits (feat(api): …), un préfixe de ticket (ABC-123 …) ou des phrases simples. S'il n'y a pas de convention claire, utilisez des phrases impératives simples.
- Si les modifications indexées font plusieurs choses sans lien, suggérez de les diviser en commits séparés avant d'écrire un message pour l'ensemble.
Format
<ligne de résumé, mode impératif, max ~72 caractères, pas de point final>
<corps : pourquoi la modification a été faite et tout ce qu'un relecteur ne peut pas voir dans le diff. Retour à la ligne à 72 caractères. Omettez le corps pour les modifications triviales.>
<trailers : Fixes #123, Co-authored-by: …, BREAKING CHANGE: …>
- Mode impératif : "Ajoute une nouvelle tentative de téléchargement", pas "Ajouté" ou "Ajoute".
- Le résumé indique ce qui a changé pour l'utilisateur ou le codebase, pas quels fichiers ont été touchés.
- Le corps explique pourquoi : le bug, la contrainte, l'alternative rejetée. Le diff montre déjà quoi.
- Avec Conventional Commits, choisissez le type honnêtement :
feat (nouveau comportement), fix (bug), refactor (pas de changement de comportement), perf, docs, test, build, ci, chore. Marquez les changements cassants avec ! et un trailer BREAKING CHANGE:.
Exemples
fix(auth): rafraîchir le token avant son expiration, pas après
Les requêtes faites dans les 30 dernières secondes de vie d'un token
échouaient avec 401 car le rafraîchissement n'avait lieu qu'à la première
échec. Rafraîchir lorsqu'il reste moins de 60 secondes à la place.
Fixes #482
Supprimer le point de terminaison d'export CSV inutilisé