View Issue Details [ Jump to Notes ]

[ Print ]

Project

Category

View Status

Date Submitted

Last Update

0007240

ITK

public

2008-06-25 11:45

2009-09-19 15:53

Reporter

Niels Dekker

Assigned To

Bill Lorensen

Priority

normal

Severity

feature

Reproducibility

always

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

Target Version

Fixed in Version

Summary

0007240: Request to support "DOC" as tag for CVS commit messages

Description

ITK's CVS commit filters require commit messages to contain one of the following tags:
   ENH: Enhancement
   BUG: #### bug fix
   STYLE: coding style fix
   COMP: fixing compilation errors or warning

While I do appreciate this system, I think it could be improved by supporting another tag: "DOC" for documentation. Which would include any changes in comment, including doxygen formatted documentation. I think it makes sense to distinguish such commits from STYLE, which includes "cosmetic" code changes and refactorings.

The "DOC" tag was discussed at [Insight-developers], "Bug fixing procedures", http://www.itk.org/mailman/private/insight-developers/2008-June/010555.html [^]

Luis Ibanez also thinks that "DOC" is a better tag for documentation than
"STYLE".

Additional Information

At LKEB (www.lkeb.nl) we're actually following your convention to use those tags in commit messages as well, for our own code base! And we've included the "DOC" tag already. :-)

Tags

No tags attached.

Resolution Date

Sprint

Sprint Status

Attached Files

Relationships

Notes
(0017648) Bill Lorensen (developer) 2009-09-19 15:53	Added users feature request.

Issue History
Date Modified	Username	Field	Change
2008-06-25 11:45	Niels Dekker	New Issue
2009-09-16 16:10	Bill Lorensen	Status	new => assigned
2009-09-16 16:10	Bill Lorensen	Assigned To	=> Bill Lorensen
2009-09-19 15:53	Bill Lorensen	Note Added: 0017648
2009-09-19 15:53	Bill Lorensen	Status	assigned => closed
2009-09-19 15:53	Bill Lorensen	Resolution	open => fixed