Compétence de Commit
Indexez et validez les modifications en suivant le style de commit conventionnel et les principes de commits atomiques.
Format du Message de Commit
<type>(<portée optionnelle>): <résumé court>
- Tout en minuscules — type, portée et résumé
- Pas de point à la fin du résumé
- Mode impératif — "ajouter fonctionnalité" pas "fonctionnalité ajoutée" ou "ajoute fonctionnalité"
- 50 caractères maximum pour la ligne de résumé (limite souple, 72 limite dure)
- Le résumé décrit le pourquoi, pas le quoi (le diff montre le quoi)
Types
| Type | Quand utiliser | Exemple |
|---|---|---|
feat | Nouvelle fonctionnalité ou capacité | feat: ajouter le flux d'authentification utilisateur |
fix | Correction de bogue | fix: corriger le pointeur nul sur entrée vide |
refactor | Changement de code qui ne corrige ni n'ajoute rien | refactor: extraire l'analyseur en module autonome |
style | Formatage, espaces blancs, points-virgules — pas de changement logique | style: appliquer le formateur aux fichiers de config |
docs | Documentation uniquement | docs: ajouter des exemples d'utilisation API au readme |
test | Ajout ou mise à jour de tests | test: ajouter la couverture des cas limites pour le validateur |
chore | Processus de build, outils, dépendances, config | chore: mettre à jour le fichier de verrouillage des dépendances |
perf | Amélioration de performance | perf: mettre en cache les recherches répétées en base de données |
ci | Changements dans le pipeline CI/CD | ci: ajouter une étape de lint au workflow PR |
Portée (Optionnelle)
Utilisez la portée pour réduire le contexte lorsque le type seul est ambigu. Dérivez les portées de la structure des répertoires du projet ou des domaines fonctionnels :
feat(auth): ajouter le rafraîchissement de jeton OAuth2
fix(api): gérer le délai d'attente sur les gros volumes
docs(contributing): ajouter les instructions d'installation
Workflow
- Examiner les modifications — Exécutez
git statusetgit diff(indexées + non indexées) pour comprendre ce qui a changé - Vérifier l'historique récent — Exécutez
git log --oneline -10pour correspondre au style de commit existant du projet - Vérifier l'intention — Confirmez que les modifications forment une unité logique unique ; sinon, suggérez de les diviser en plusieurs commits
- Exécuter les vérifications CI — Avant d'indexer, exécutez les linters, formateurs et la suite de tests du projet pour détecter les problèmes tôt. Vérifiez les scripts
package.json,Makefile, ou la configuration CI pour les commandes disponibles. Corrigez toute défaillance avant de continuer. - Indexer les fichiers — Ajoutez des fichiers spécifiques par nom (
git add fichier1 fichier2), jamaisgit add -Aougit add . - Rédiger le message — Sélectionnez le type correct, ajoutez une portée si utile, rédigez un résumé impératif
- Commiter — Utilisez un heredoc pour le message afin de garantir un formatage propre
- Vérifier — Exécutez
git statusaprès pour confirmer que le commit a réussi
Commits Multi-lignes
Pour les commits qui nécessitent un corps (rare — préférez les messages concis sur une seule ligne) :
<type>(<portée>): <résumé>
<coprs expliquant pourquoi, pas quoi>
- Ligne vide entre le résumé et le corps
- Le corps est coupé à 72 caractères
- N'utilisez le corps que lorsque le résumé seul ne peut pas exprimer le raisonnement
Règles
- Commits atomiques — Un changement logique par commit. Une fonctionnalité et ses tests peuvent constituer un commit. Une correction de formatage non liée doit être un commit séparé.
- Pas de secrets — Ne commitez jamais
.env, identifiants, clés API ou jetons. Avertissez l'utilisateur si ceux-ci sont indexés. - Pas d'artefacts générés — Ne commitez pas la sortie de build, les répertoires de dépendances ou les fichiers compilés. Vérifiez la couverture de
.gitignoreavant d'indexer. - Nouveaux commits uniquement — Créez toujours un nouveau commit. Ne modifiez jamais un commit sauf demande explicite de l'utilisateur.
- Pas de saut de hooks — N'utilisez jamais
--no-verify. Si un hook échoue, corrigez le problème sous-jacent. - Ligne de co-auteur — Ajoutez le pied de page co-auteur lorsque Claude a écrit ou co-écrit les modifications :
Co-Authored-By: Claude <[email protected]>
Exemples
# Fonctionnalité — nouvelle capacité
feat: ajouter le système de notification webhook
# Fonctionnalité avec portée
feat(api): ajouter un middleware de limitation de débit
# Correction — correction de bogue
fix: empêcher le plantage sur entrée JSON malformée
# Style — formatage uniquement
style: appliquer une indentation cohérente dans les modules
# Docs — documentation
docs: ajouter les enregistrements de décision d'architecture
# Chore — outillage/config
chore: élargir gitignore pour couvrir les artefacts de build
# Test avec portée
test(auth): ajouter des tests d'intégration pour le rafraîchissement de jeton
# Refactor avec portée
refactor(db): remplacer les requêtes brutes par un constructeur de requêtes
Documentation de Référence
- conventional-commits.md — guide de sélection des types, changements cassants, stratégies de portée, décisions de commits multi-fichiers, formatage du corps, pieds de page et erreurs courantes