Commit comments guidelines

Commit Comments Guidelines
The following are guidelines to help keep our SVN comments consistent as well as make the commit log a helpful tool for tracking changes. It is desirable that project members use the formats given below when making commits.

If a commit has an associated Trac Ticket:
Ticket # : Patch by. 

Where:
 * is the associated Trac ticket number
 * is the name of author of the change being made. The name should be the author's registered forum name whenever possible. May not always be the same as the person committing the change.
 *  is free form text describing the change made. Whenever possible these comments should come directly from the author, not the person who commits the change.

If a commit does not have an associated Trac Ticket:
Patch by.  Where:
 * is the name of author of the change being made. The name should be the author's registered forum name whenever possible. May not always be the same as the person committing the change.
 *  is free form text describing the change made. Whenever possible these comments should come directly from the author, not the person who commits the change.

For code changes:
Whenever possible the author's comments should include the name of Classes modified as well as a description of modified logic. The author's comments should be as descriptive as possible.

Unacceptable comments include:
 * "Fixed bug"
 * "Fixed bug described in Ticket"
 * "No comment"