[ds6-devel] Re: ChangeLog

[Chris Leishman]

On Sunday, January 19, 2003, at 03:59 PM, Mauro Tortonesi wrote:

> On Sun, 19 Jan 2003 chris at deepspace6.net wrote:
>
>> Update of /cvs/nc6
>>
>> Modified Files:
>> 	ChangeLog
>> Log Message:
>> Updated based on CVS commit mails.  I've only put in major
>> changes/enhancements.  If I've missed something, then just add it in.
>
> perhaps we should start updating ChangeLog when we commit changes?

Yes.

The usual practice I go by is to add entries to the ChangeLog when 
anything is changed that people may need to know about.  So I wouldn't 
bother putting in a message for simple fixes, but I would for slightly 
more substantial changes.  Unfortunately it's a bit hard to say what 
the threshold is - I usually just apply common sense.  I usually find 
it ok to aggregate changes into a single entry, as long as it still 
conveys what was done.

An out-of-date ChangeLog is bad, but it's also annoying when the 
ChangeLog lists every single minor change.  So my answer would be yes, 
but don't overdo it.

The other thing is branches.  The ChangeLog should be maintained within 
a branch, but when the branch is merged back into the trunk, all the 
changes should be aggregated into one single entry in the ChangeLog of 
the trunk (just detailing that the merge took place and what changes 
this made).

Does that make any sense?

Regards,
Chris