Kokua:Commit Message Guidelines

This is a draft, not an actual policy (yet)

(If this becomes an actual policy, rules would be mandatory to follow while recommendations would be mere suggestions on what to do when unsure.)


 * 1) The following rules and recommendations only apply to changesets we, the Kokua contributors and Kokua project members, originally commit, not changesets we pull or cherry-pick from other projects' repositories.
 * 2) Rule: A changeset that is intended to (partially) fix or implement one or several bugs/features/changes already filed on our issue tracker (redmine.kokuaviewer.org) must refer to at least one of the corresponding issue ID in its commit message.
 * 3) Recommendation:  A changeset that is loosely related to one or several bugs/features/changes already filed on our issue tracker (and not fixing or implementing any other tracked issues) should refer to at least one of the corresponding issue ID in its commit message.
 * 4) Recommendation: A changeset that fixing, implementing or relating to several issues should refer to all of them.
 * 5) * Exception: There is no need to refer to issues closed as duplicates of other issues, when those other issues are being referred to already.
 * 6) Rule: The references of rule 2 (and of recommendation 3 and 4, if any) must be of the format , where   is the Redmine issue number on your issue tracker without the leading ' '.
 * 7) * Example:
 * 8) Rule: The references of rule 2 (and of recommendation 4, if any) in the format of rule 5 must be located on the first line of the commit message.
 * 9) * Recommendation: Anywhere on that line is fine, but prefer somewhere near its beginning.
 * 10) * Note: Additional references in the same or other formats on the first line or anywhere else in the commit message are fine where they make sense. We just require one reference to each referred-to issue be on the first line and of the mentioned format.
 * 11) Rule: The first line of the commit message must contain some description of the change besides the ID references required above.
 * 12) Recommendation: To fulfill rule 7, describe in prose what the specific changeset changes and (maybe on further lines) why. If you feel unable to come up with something appropriate, simply include the "subject" line of one of the referred issues, maybe prepended by "fixed" or "implemented" as appropriate.