Messages de Commit

Pourquoi les messages de commit sont importants

Les messages de commit jouent un rôle crucial dans la compréhension de l'historique d'un projet. Des messages de commit bien rédigés facilitent la compréhension pour les collaborateurs, les développeurs futurs, et même vous-même, du but et du contexte de chaque changement. Un historique de commit clair facilite la collaboration, le débogage et le processus d'identification des changements spécifiques dans la chronologie d'un projet.

Anatomie d'un bon message de commit

1. Concision et clarté

Un message de commit doit être concis et aller droit au but. Il doit clairement transmettre le but du commit en une seule ligne. Évitez l'ambiguïté et fournissez suffisamment d'informations pour comprendre le changement sans avoir à regarder le code réel.

2. Séparer le sujet du corps

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

Prenons un exemple d'un tel message de commit :

Dans ce cas, cependant, nous allons simplement exécuter la commande git commit sans le drapeau -m :

L'éditeur de texte par défaut pour Git sera ouvert, où vous pourrez écrire un message de commit détaillé. Vous devrez ensuite l'enregistrer et quitter l'éditeur de texte de manière appropriée.

Faisons un autre commit dans notre dépôt :

Voici la commande que nous avons utilisée pour modifier notre fichier texte :

Le message de commit est le suivant :

Si vous ne pouvez pas modifier le fichier, appuyez sur la touche i. Cela garantit que vous entrez en mode édition. Encore une fois, pour enregistrer les modifications et quitter Vim, appuyez sur la touche Échap et deux lettres majuscules Z.

Remarque

Si vous avez un éditeur de texte par défaut différent pour le terminal (autre que Vim) et que vous rencontrez des difficultés, vous pouvez facilement trouver comment enregistrer les modifications et le quitter sur Internet.

3. Utiliser le mode impératif

Rédigez les messages de commit à l'impératif, ce qui donne une direction pour le changement. Commencez le sujet par un verbe, tel que "Corriger", "Ajouter" ou "Mettre à jour."