[Insight-developers] Bug fixing procedures

[Luis Ibanez]

Hi Niels,

Yes, "DOC" is certainly a better tag for documentation than
"STYLE". They definitely address different aspects of code
modification.

Could you please add a bug entry to the MANTIS bug tracker
indicating the need for adding "DOC" as a valid tag in our
CVS commit filters ?


About the need for running experimental builds at every change,
it is true that a documentation change is usually more relaxed.

However, it is not uncommon to make a "minor" modification in
a doxygen comment and to end up missing an opening "/**" or
a closing "*/" and causing mayhem in the build.  :-/

A more prudent rule will be to, at least, locally build the
Testing suit of the directory where the modified file is,
before committing the modifications to the repository.


   Thanks


      Luis


-------------------
Niels Dekker wrote:
> 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,