[IPython-dev] On good commit messages

Fernando Perez fperez.net at gmail.com
Sat Apr 9 17:43:20 EDT 2011


Hi all,

I was reviewing some pull requests, and in making some comments about
the commits and searching for background info, came across this great
post:

http://who-t.blogspot.com/2009/12/on-commit-messages.html

I'll be adding a link to it in our development guide, but I think it
makes for a worthwhile 5 minute read.  I don't really agree with the
idea that "As a rule of thumb, given only the commit message, another
developer should be able to implement the same patch in a reasonable
amount of time.", I don't really think that's realistic.  But
otherwise it's a bunch of sensible advice, well worded and with the
reasons behind the advice.

Cheers,

f



More information about the IPython-dev mailing list