Messages de Commit

Pourquoi les messages de commit sont importants

Les messages de commit sont essentiels pour comprendre l'historique d'un projet. Des messages clairs et significatifs aident les collaborateurs, les développeurs futurs et vous-même à saisir le but et le contexte de chaque modification. Un historique de commit bien structuré améliore la collaboration, simplifie le débogage et facilite la recherche de modifications spécifiques dans la chronologie du projet.

Anatomie d'un bon message de commit

1. Concision et clarté

Un message de commit doit être concis et précis. Il doit clairement exprimer le but du commit en une seule ligne. Éviter toute ambiguïté et fournir suffisamment d'informations pour comprendre la modification sans avoir à consulter le code réel.

Bad: "Fixed a bug"
Good: "Fix issue with user authentication in login form"

2. Séparer le sujet du corps du message

Si plus de détails sont nécessaires, séparer le sujet du corps du message de commit par une ligne vide. Le sujet doit résumer la modification, et le corps peut fournir un contexte supplémentaire, les raisons du changement et toute information pertinente.

Voici un exemple de message de commit de ce type :

Subject: "Add validation for user email input"

Body: "This commit introduces email format validation to ensure
that users provide a valid email address when registering. It
helps improve the overall data integrity of the system."

Dans ce cas, exécuter la commande git commit sans l'option -m :

git commit

L’éditeur de texte par défaut de Git s’ouvrira, où il est possible de rédiger un message de commit détaillé. Il convient ensuite de l’enregistrer et de quitter correctement l’éditeur de texte.

Création d’un nouveau commit dans le dépôt :

Commande utilisée pour modifier le fichier texte :

echo "Git is the most popular VCS in the world used by millions of developers since it allows efficient collaboration via committing, reverting and merging changes. Besides, Git is free and open source and can be easily installed on Windows, macOS, Linux and all Unix-based platforms." >> test.txt

Message de commit comme suit :

Subject: "Add description of Git"
  
Body: "This commit introduces brief description 
of Git and highlights its key features. It also 
states the reasons for the widespread popularity 
of Git."

Si vous ne pouvez pas modifier le fichier, appuyez sur la touche i. Cela permet d'entrer en mode édition. Encore une fois, pour enregistrer les modifications et quitter Vim, appuyez sur la touche Échap puis deux fois sur la lettre Z majuscule.

3. Utiliser le mode impératif

Rédiger les messages de commit à l’impératif, ce qui donne une orientation au changement. Commencer le sujet par un verbe, comme « Corriger », « Ajouter » ou « Mettre à jour ».

Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"