Commit Log Guide
When entering text to be included in a version control commit log message, please follow this guide.
- Imagine you're reading this same log message 10 years from now. What would be most helpful for you to quickly recall why these changes were made?
- Imagine someone else is reading this same log message 10 years from now. What would be most helpful for them to quickly understand what this commit changes and why it was done?
- Should your commit be merged to another branch? Say so.
- Be verbose!
- This is the chance to use time/context sensitive information relevant to the commit.
- Source code can be changed later, but commit log messages cannot. Make it count.
- Refer to related content, like
- issue tracker items
- if this commit fixes, for instance, issue tracker item #2642, the very first phrase in the commit log should be
FIXED MIFOS-1922(case & spacing are significant). The build in Hudson which fixes the issue will be linked to from the issue, as well as the commit in version control. Examples: MIFOS-3458, d50c97.
- if this commit fixes, for instance, issue tracker item #2642, the very first phrase in the commit log should be
- mailing list discussions
- other changesets: "related to commit f243493977b3c9444cde8d4d7266bc1b919007f1"
- issue tracker items
- More tips from Junio C. Hamano
- More tips from Tim Pope