Rédiger un commit lisible

Une modification préparée n’est pas encore une version enregistrée : tant qu’elle n’est pas commitée, votre travail peut rester difficile à comprendre ou à reprendre. Dans cette leçon, vous allez enregistrer la portion préparée de README.md en décrivant précisément son intention.

Vous avez déjà préparé cette portion avec git add -p dans la leçon précédente. Un commit enregistre le contenu de la zone de préparation ; son message permet à une autre personne, ou à vous-même plus tard, d’identifier le changement sans devoir relire immédiatement tous les fichiers.

Un commit, une intention

Un commit lisible porte sur une intention cohérente : par exemple, expliquer les étapes Git du projet dans README.md. Évitez de regrouper dans le même commit des changements sans lien, comme une documentation et une refonte de la page. Des commits ciblés rendent les décisions plus faciles à comprendre et à revoir.

Rédiger le message et créer le commit

Rédigez le message à l’impératif, en français, et commencez directement par l’action. « Documenter les étapes Git du projet » indique clairement ce que le commit apporte. Préférez cette formulation à un intitulé vague comme « Modifications » ou à une description au passé comme « Documentation ajoutée ».

cd suivi-site
git status
git diff --cached
git diff
git commit -m "Documenter les étapes Git du projet"

Le commit est créé à partir du contenu préparé de README.md. Le message affiché par Git peut ressembler à :
[main a1b2c3d] Documenter les étapes Git du projet
 1 file changed, 1 insertion(+)

La première commande vous replace dans le dossier du projet. git status permet de confirmer l’état de préparation avant l’enregistrement ; git diff --cached affiche le contenu qui sera inclus dans le commit. La commande git diff vérifie séparément qu’aucune modification non préparée ne reste de côté, puis git commit -m crée le commit avec le message fourni.

Le texte entre crochets dans la sortie, comme a1b2c3d, est un identifiant affiché par Git : sa valeur sera différente sur votre machine. La ligne indique aussi le nombre de fichiers et de lignes modifiés. Git n’enregistre que ce qui était préparé au moment du commit ; la vérification préalable vous aide donc à éviter d’inclure un changement inattendu.

Vérifier le résultat

git status

On branch main
nothing to commit, working tree clean

Le dépôt est maintenant propre : le contenu préparé a été enregistré et aucune autre modification n’attend de traitement. Si votre branche porte un autre nom que main, Git affichera celui-ci à la place ; cela ne change pas le résultat attendu.

À retenir

• Un commit doit correspondre à une intention cohérente.
• Vérifiez le contenu préparé et les modifications non préparées avant l’enregistrement.
• Rédigez un message bref, précis, à l’impératif et en français.
• Utilisez git commit -m pour créer le commit avec son message.
• Contrôlez ensuite avec git status que le dépôt est dans l’état attendu.

Dans la prochaine leçon, vous apprendrez à parcourir les commits pour retrouver les étapes enregistrées dans le projet.