af83

Git commit message

git commit -m 'Devblog: Importance des messages de commit'

Les messages de commit sont importants pour la compréhension du patch et pour cibler/intéresser un code-reviewer.

Si vous voulez aussi que votre patch soit accepté par un projet, il est souvent apprécié que votre message soit cohérent et explique votre modification. Ceci aide le travail de l'upstream et augmente les chances qu'il soit intégré.

Un bon moyen de montrer le sérieux de l'auteur est de signer le message par l'option -S. Vous pouvez lire cet article pour plus d'informations dessus.

Les conventions de formatage viennent de l'utilisation des emails pour envoyer un patch pour le kernel, avec la commande git format-patch.

La première ligne doit avoir moins de 50 caractères (c'est le sujet du mail).

Avec pour format d'exemple :

Sujet: Courte description des changements de ce patch (que fait ce patch ?)

Une description si nécessaire plus détaillée du pourquoi, problème rencontré...
Comme pour les emails, la description ne devrait pas dépasser 80 caractères.

On peut mettre le ticket ou numéro de ticket sur une autre ligne.

Si le commit a été relu ou fait par plusieurs développeurs, il y a le mot clef
`Signed-off-by:` (`--signoff`). Ou encore `Reported-by:` pour les bugs reportés.

Linus parle justement de ces mots clef sur github.

N'hésitez pas, non plus, à consulter des projets avec des messages de commit bien faits :

blog comments powered by Disqus