[IPython-dev] Ready to go with 0.7.2

Fernando Perez fperez.net at gmail.com
Wed Jun 7 13:55:49 CDT 2006


On 6/7/06, Walter Dörwald <walter at livinglogic.de> wrote:

> I guess from now on any changes should be documented in ChangeLog.

Yes, please.  As I state in

http://projects.scipy.org/ipython/ipython/wiki/DeveloperGuidelines#TheChangeLogisveryimportant

the changelog really is very important.  It serves as a detailed
history of the changes and their reasons, more so than commit
messages.  Esp. because typically you work for a while (sometimes
days) before committing.  I find that if I don't log to the ChangeLog
things /as I do them/, later when the time to commit comes, I don't
really remember all the changes I made.  So my approach is:

- ChangeLog: detailed report of what I'm changing, as I go.

- commit message: brief summary of the effect of the commit,
highlighting anything of special importance that other devs should pay
attention to.

Cheers,

f




More information about the IPython-dev mailing list