[mantisbt-dev] How to Write a Git Commit Message?

[Victor Boctor]

Hi all,

I’ve noticed lately that there are a lot of feedback in the pull requests about what makes a good commit message. I would like to suggest that we adopt the approach suggested in the following blog post as a standard for MantisBT. We can amend if needed, but I think it is a very good start.

http://chris.beams.io/posts/git-commit/

The abstract for those who don’t have time to read:

1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line (e.g. Fix blah blah, Update getting started documentation, …etc)
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how

Thanks,
-Victor

[d***@mantisbt.org]

I’ve noticed lately that there are a lot of feedback in the pull requests
about what makes a good commit message. I would like to suggest that we
adopt the approach suggested in the following blog post as a standard for
MantisBT. We can amend if needed, but I think it is a very good start.
http://chris.beams.io/posts/git-commit/

Hi Victor

Thanks for that. I actually reached the same conclusion a long time ago ;)
see

http://mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages