Aller au contenu principal
Télécharger

Messages de commit Git : les bonnes pratiques

Tes messages de commit sont la documentation de l'historique de ton projet. Apprends les règles, formats et habitudes qui les rendent vraiment utiles.

GitQuest
Démo

Par Anaïs Sparesotto, développeuse web et responsable pédagogique · Mis à jour le

Anatomie d'un bon message de commit

Ligne de sujet (obligatoire)

Un résumé court du changement, 50 caractères maximum. Écrit au mode impératif ("Ajouter" et non "Ajoute" ou "Ajout de"). Pas de point à la fin.

feat: ajouter la vérification email à l'inscription

Ligne vide (séparateur)

Sépare toujours le sujet du corps avec une ligne vide. Git utilise cette séparation pour distinguer le résumé de la description.

Corps (optionnel)

Explique pourquoi le changement a été fait, pas quoi (le diff montre le quoi). Coupe les lignes à 72 caractères. Référence les issues ou tickets quand c'est pertinent.

Les utilisateurs pouvaient s'inscrire avec des

emails invalides, causant des notifications en

erreur. Cet ajout vérifie l'email avant

l'activation du compte.

Closes #187

Les règles d'or

7 règles pour des messages de commit parfaits

Ces conventions sont largement adoptées dans l'industrie. Suis-les et tes collègues te remercieront.

1

Sujet de 50 caractères max

Force la concision. GitHub tronque après 72 caractères de toute façon.

2

Majuscule au début du sujet

"Fix bug" et non "fix bug". Commence par une majuscule pour la cohérence.

3

Pas de point à la fin

La ligne de sujet est un titre, pas une phrase. Chaque caractère compte dans 50 caractères.

4

Utiliser le mode impératif

"Ajouter" et non "Ajoute". Suit les conventions de Git lui-même (ex: "Merge branch").

5

Ligne vide avant le corps

Nécessaire pour que git log, shortlog et de nombreux outils fonctionnent correctement.

6

Corps coupé à 72 caractères

Git ne coupe pas le texte automatiquement. Garde les lignes lisibles dans les terminaux.

7

Expliquer pourquoi, pas quoi

Le diff montre ce qui a changé. Le message doit expliquer la motivation derrière le changement.

Le format Conventional Commits

Une convention populaire qui préfixe chaque message avec un type. Permet la génération automatique de changelogs et le versioning sémantique.

feat:

Une nouvelle fonctionnalité pour l'utilisateur

feat: ajouter le mode sombre

fix:

Une correction de bug

fix: corriger le timeout de connexion

docs:

Modifications de documentation uniquement

docs: mettre à jour le guide de contribution

refactor:

Changement de code sans correction de bug ni ajout de fonctionnalité

refactor: simplifier le middleware auth

test:

Ajout ou mise à jour de tests

test: ajouter les tests e2e du checkout

chore:

Tâches de maintenance (deps, CI, outillage)

chore: mettre à jour eslint en v9

Bon vs mauvais : trouve la différence

Compare un git log propre avec un git log brouillon. Sur quel projet préférerais-tu travailler ?

Bons messages

Mauvais messages

Avant et après : réécrire les mauvais messages

Mauvais

fix truc

Qu'est-ce qui a été corrigé ? Où ? Pourquoi ?

Bon

fix: empecher le crash quand le profil utilisateur est null

Type clair, portée et description de la correction.

Mauvais

mis a jour le code pour les nouvelles couleurs du design system et aussi change des styles de boutons et corrige quelques trucs dans le header

Beaucoup trop long, mélange plusieurs changements, pas de structure.

Bon

refactor: migrer les styles de boutons vers les tokens du design system

Un changement par commit. Le reste dans des commits séparés.

Mauvais

WIP

Pas un message de commit. Utilise les branches ou le stash pour le travail en cours.

Bon

feat: ajouter le composant barre de recherche (sans resultats pour l'instant)

Honnête sur l'état d'avancement, mais toujours descriptif.

Écrire ses commits : éditeur vs en ligne

Utilise git commit pour des messages détaillés ou -m pour les rapides.

Avec l'éditeur (détaillé)

Avec le flag -m (rapide)

Fait partie du guide Les bases de Git

A

GitQuest est conçu par Anaïs (nouvelle fenêtre), développeuse web et responsable pédagogique, spécialisée en formations tech et accessibilité numérique.

Questions sur les messages de commit

Pratique l'écriture de bons commits dans un terminal sécurisé

Les enquêtes GitQuest te mettent face à des situations réelles où des messages de commit clairs font toute la différence.