Just yesterday I was reading Tim Pope’s note about git commit messages, and I really liked it. What I wanted to share though was my surprise today, when I signed in Github to check my git history after having tried to follow his template during the morning.
In a nutshell
Summarizing Tim’s note as much as possible (although I encourage you to read his post better), the suggestions basically are:
- Start your commit message with a summary phrase, no more than 50 characters.
- Add any explanations below, after a couple of line breaks
- Wrap the message yourself to around 72 characters, ‘cause git ain’t gonna do it for ya.
The cool thing about this is that this isn’t just about having
git log display the messages in a nice format,
which it does, but that further integrations with git also work better, Github for example.
These are two examples from my work this morning. In the first one, you can see how, by making the summary way too long, you can barely understand it, since it breaks.
On the other hand, these nicely written commits have their summary properly displayed and the description when you click on the three dots.
As you can see the difference is huge, so even if it’s just to be able to browse our git history from Github and be able to read all the explanations nicely, it’s worth the effort.