git commit - format?

Question

Quel est le format recommandé à utiliser dans les messages de validation de git (COMMIT_EDITMSG), s'il y en a?

Answer 1

Il varie, bien sûr, mais un format très commun est quelque chose comme ceci (extrait de http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html, que je pense que ce sommes vraiment bien):

Short (50 chars or less) summary of changes 

More detailed explanatory text, if necessary. Wrap it to about 72 
characters or so. In some contexts, the first line is treated as the 
subject of an email and the rest of the text as the body. The blank 
line separating the summary from the body is critical (unless you omit 
the body entirely); tools like rebase can get confused if you run the 
two together. 

Further paragraphs come after blank lines. 

- Bullet points are okay, too 

- Typically a hyphen or asterisk is used for the bullet, preceded by a 
    single space, with blank lines in between, but conventions vary here 

Une chose qu'il ne traite pas quelque chose J'ai adopté pour moi-même, à savoir en utilisant des balises courtes au début de la première ligne pour identifier quel genre de commettre c'est. Cela peut être des balises comme [fix] pour une correction de bogue, [new] pour une nouvelle fonctionnalité ou [dev] pour un commit qui n'affecte que les internes. Avec une politique comme celle-là, il est facile d'autogénérer un changelog depuis les commits.

Edit: Voici un autre bon résumé, ce site même: In git, what are some good conventions to format multiple comments to a single commit

Answer 2

Je ne recommanderais pas de grands messages. Si vous ne pouvez pas expliquer en une phrase ce que vous faites, votre engagement comporte trop de changements. Utilisez git rebase -i et divisez votre commit si vous avez déjà validé. Si vous n'avez pas encore validé les modifications, utilisez git add -p pour mettre en scène de petites parties et ensuite commettre comme des commits de plus petite taille.

Un historique des modifications granulaires comme celui-ci aidera les fusions et les rebases ultérieures. Il vous aidera également à établir un lien avec votre outil de suivi des problèmes. Si vous avez 2 tickets ou plus adressés, il sera plus difficile de déchiffrer quel ticket chaque changement dans le commit adressé.