Proposal: Start requiring "code release notes" on a bug-level

[Jason Pyeron]

change notes. We keep a database of them.

If an engineer needs to change something, they submit a change request, 
then they get a change approval, then the team get the change notes.

The change notes are formatted like so:

 When    : The date
 What    : list of spec/function which were changed
 Where   : list of modules touched by change
 How     : what types of change
 Who     : list of engineers, who did the change THEMSELVES
 Summary : free text


Ex:

 When    : 9:33 7/22/2004
 What    : none
 Where   : power line condition module
 How     : Part substitution
 Who     : Bob Smith, Jane Doe
 Summary : The 0.01 nano farad capacitor costs too much.
           For C32, we are now using a 0.02 nano farad capacitor.

Ex:

 When    : 9:34 7/22/2004
 What    : return value
 Where   : fibinachi function
 How     : code logic
 Who     : Bob Smith
 Summary : The fibinachi function should return 0 up to and until 0, we 
           don't want it to return negative numbers. 
           if (idx<0) idx=0;


On Thu, 22 Jul 2004, Jouni Heikniemi wrote:

> It was a bad idea to even start using the term "release notes" in this 
> discussion. I didn't come up with anything better and I still don't have 
> a good idea, but it is confusing. Gerv is right: user-wise relnotes 
> should be different and apart from this. If we don't group this "code 
> knowledge" by release (which is fine, if we integrate it into devguide 
> anyway), we don't have to find a way to automatically collect the 
> information either.


-- 
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-                                                               -
- Jason Pyeron                   http://www.pyerotechnics.com   -
- Partner & Sr. Manager         Pyerotechnics Development, Inc. -
- +1 (443) 451-2697             500 West University Parkway #1S -
- +1 (410) 808-6646 (c)         Baltimore, Maryland  21210-3253 -
-                                                               -
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

This message is for the designated recipient only and may contain 
privileged, proprietary, or otherwise private information. If you 
have received it in error, purge the message from your system and 
notify the sender immediately.  Any other use of the email by you 
is prohibited.