Part 2 of usable subversion comments is about what to include in svn comments.

The content of subversion comments can vary depending on what is being checked in. My conclusion is that content of the comments should be functional. One can go into great detail, or be fairly abstract. This should still be left up to the person making the comments, because with software development we work at different levels of abstraction depending on the situation.

The template I am looking to establish is a general guideline to provide a consistent format for a revision control log that allows us to quickly scan it. If we can scan quickly, and understand what happened we get an idea of the history of certain section of our repository. Here is a breakdown of what should be included, and how to describe it, and how to prefix your subject.

Type of Commit         How to commentand 'Prefix'           the commit ==========================================================================

Bug Fix                1. Describe the problem'Fix '                 2. Describe the fix

New Feature            1. Describe the new feature'New'                  2. Described anything that had to change

Change Feature         1. Describe the change'Update'               2. Describe where the change was made                       3. Describe anything anything that was impactedHousekeeping           1. General description of what changed,'Clean'                   and why.

Fix XML Output Display

1. My example node was not being included.2. Changed logic in GenerateNode() to include this node by default.

Bookmark It