Le diff vous dit déjà quoi

Un message de commit qui dit "Mis à jour le contrôleur utilisateur" est du gâchis d'octets — git diff montre déjà que le contrôleur utilisateur a été mis à jour. La partie précieuse est le pourquoi.

Le format en sept règles

• Séparez le sujet du corps avec une ligne vide.
• Limitez le sujet à 50 caractères.
• Capitalisez le sujet.
• Ne terminez pas le sujet par un point.
• Utilisez le mode impératif ("Fix bug", pas "Fixed bug").
• Wrappez le corps à 72 caractères.
• Utilisez le corps pour expliquer quoi et pourquoi, pas comment.

Un exemple

git commit -m "Reject negative quantities in checkout

Les clients pouvaient soumettre des quantités négatives en éditant
le DOM, ce qui appliquait des crédits au total. Nous ajoutons une
validation côté serveur dans CheckoutValidator car les vérifications
côté client seules sont insuffisantes contre les clients scriptés."

Conventional Commits

git commit -m "feat(checkout): reject negative quantities"
git commit -m "fix(auth): handle expired refresh tokens"
git commit -m "docs(readme): clarify install steps"

Les templates rendent ça automatique

cat > ~/.gitmessage 'EOF'
# Sujet (50 caractères max)

# Pourquoi ce changement est-il nécessaire ?

# Comment résout-il le problème ?

# Effets de bord, suivis, liens ?
EOF
git config --global commit.template ~/.gitmessage

Référencer les issues

git commit -m "Fix avatar upload race condition

See: PROJ-2207
Co-authored-by: Alex Tan "