[Insight-developers] Bug fixing procedures

[Niels Dekker]

Hi Luis,

> Note that our CVS commit filters require your commit messages
> to contain one of the following tags:
>
>   ENH: Enhancement
>   BUG: #### bug fix
>   STYLE: coding style fix
>   COMP: fixing compilation errors or warnings

At LKEB (www.lkeb.nl) we're actually following this convention for 
commit messages as well, for our own code base!  :-)  We've even added 
another tag: DOC, for documentation: any changes in comment, including 
doxygen.  I think it makes sense to distinguish such commits from STYLE, 
which includes "cosmetic" code changes and refactorings.  What do you 
think of using "DOC"?

I guess it's recommended to do an Experimental Test before committing a 
STYLE-change, while a DOC-only change could be safely committed without 
doing an Experimental... right?

Kind regards,
-- 
Niels Dekker
http://www.xs4all.nl/~nd/dekkerware
Scientific programmer at LKEB, Leiden University Medical Center