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 traçabilité des 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 l’objectif 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
Si des détails supplémentaires 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 de la modification et toute information pertinente.
Voici un exemple de message de commit structuré ainsi :
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 :
L’éditeur de texte par défaut de Git s’ouvrira, vous permettant de rédiger un message de commit détaillé. Il convient ensuite de l’enregistrer et de quitter correctement l’éditeur de texte.
Effectuons un autre commit dans notre dépôt :
Voici la commande utilisée pour modifier le fichier texte :
Le message de commit est le suivant :
Si vous ne pouvez pas modifier le fichier, appuyez sur la touche i. Cela vous permet d’entrer en mode édition. Pour enregistrer les modifications et quitter Vim, appuyez à nouveau sur la touche Échap puis deux fois sur la lettre Z majuscule.
Si vous utilisez un autre éditeur de texte par défaut dans 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 orientation au changement. Commencez le sujet par un verbe, comme « Fix », « Add » ou « Update ».
Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"
Merci pour vos commentaires !
Demandez à l'IA
Demandez à l'IA
Posez n'importe quelle question ou essayez l'une des questions suggérées pour commencer notre discussion
Awesome!
Completion rate improved to 3.57Messages de Commit
Glissez pour afficher le menu
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 traçabilité des 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 l’objectif 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
Si des détails supplémentaires 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 de la modification et toute information pertinente.
Voici un exemple de message de commit structuré ainsi :
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 :
L’éditeur de texte par défaut de Git s’ouvrira, vous permettant de rédiger un message de commit détaillé. Il convient ensuite de l’enregistrer et de quitter correctement l’éditeur de texte.
Effectuons un autre commit dans notre dépôt :
Voici la commande utilisée pour modifier le fichier texte :
Le message de commit est le suivant :
Si vous ne pouvez pas modifier le fichier, appuyez sur la touche i. Cela vous permet d’entrer en mode édition. Pour enregistrer les modifications et quitter Vim, appuyez à nouveau sur la touche Échap puis deux fois sur la lettre Z majuscule.
Si vous utilisez un autre éditeur de texte par défaut dans 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 orientation au changement. Commencez le sujet par un verbe, comme « Fix », « Add » ou « Update ».
Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"
Merci pour vos commentaires !
