Aide à la rédaction de messages de commit
Format
Utilisez les Conventional Commits :
(<portée>) :
[corps optionnel expliquant POURQUOI, pas QUOI]
Types
| Type | Utilisation |
|---|---|
feat | Nouvelle fonctionnalité |
fix | Correction de bug |
docs | Documentation uniquement |
style | Formatage, aucun changement de logique |
refactor | Modification du code sans ajout de fonctionnalité ni correction de bug |
test | Ajout ou mise à jour de tests |
chore | Maintenance (dépendances, configuration) |
Règles
- Ligne d'objet : 72 caractères maximum, mode impératif ("ajouter" pas "ajouté")
- La portée est facultative mais recommandée (ex.
auth,api,ui) - Le corps explique pourquoi, pas quoi (le diff montre quoi)
- Un seul changement logique par commit
Workflow
- Exécutez
git diff --stagedpour voir les modifications en attente - Identifiez le type et la portée principaux
- Rédigez le message
- Vérifiez : objet ≤ 72 caractères, mode impératif, explique pourquoi si non évident
Exemples
Fonctionnalité : feat(auth) : ajouter un point de terminaison de rafraîchissement du jeton JWT
Empêche la déconnexion des utilisateurs lors de longues sessions
Correction de bug : fix(reports) : corriger le formatage des dates dans la conversion de fuseau horaire
Les horodatages étaient affichés en heure locale au lieu de l'UTC
Documentation : docs : ajouter les instructions d'installation au README