[ImageJ-devel] How to write a good commit message

[Curtis Rueden]

Hi everyone,

For those working on the ImageJ codebase, here is a nice article on how to
right good commit messages:

  http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Same advice applies to SVN too; especially since anyone using git-svn will
see commit messages formatted according to git conventions.

Also, because we use Trac, you can use Trac markup in the messages. In
particular, if you want to use bullet points, you can use two spaces
followed by an asterisk, with hanging indent after that.

For example:

Add several features to facilitate foobar support:
>
>   * Delintify the fizzwidget.
>   * Unscramble the thingamawhatsit.
>

When done this way, the message will look nice from both command line tools,
and the Trac web interface.

Regards,
Curtis
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://imagej.net/pipermail/imagej-devel/attachments/20110324/2b272ea5/attachment.html>