Writing good commit messages

The author of Pro Git (an excellent online book) gives this advice for commit messages:

Getting in the habit of creating quality commit messages makes usingand collaborating with Git a lot easier. As a general rule, yourmessages should start with a single line that's no more than about 50characters and that describes the changeset concisely, followed by ablank line, followed by a more detailed explanation. The Git projectrequires that the more detailed explanation include your motivation forthe change and contrast its implementation with previous behavior —this is a good guideline to follow. It's also a good idea to use theimperative present tense in these messages. In other words, usecommands. Instead of "I added tests for" or "Adding tests for," use"Add tests for." Here is a template originally written by Tim Pope attpope.net:

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

If all your commit messages look like this, things will be a lot easier for you and the developers you work with.  The Git project has well-formatted commit messages — I encourage you to run git log --no-merges there to see what a nicely formatted project-commit history looks like.