Note: this is an extract from Heyday's internal docs, written by me. Published as a Gist to share the love.
We like sensible commit messages. There're a lot of good articles about writing great, useful commit messages, but here's the gist of what we like:
- The single most important thing is: commit messages should explain why you are making the change.
- Think, "what would future me want to know about this change?"
- Avoid committing multiple sets of ideas/changes in the same commit: split them up.
- Don't assume the reader understands what the original problem was.