Git Commit Template

[Parker Coates]

On Fri, Mar 4, 2011 at 10:58, John Layt wrote:
> Below is one final draft of the Commit Template.  If no-one objects I will ask
> the sysadmins to add it to the necessary repositories.

NOTE: The following is bikeshedding. I support the idea of a commit
template and do not object to the one you suggest. The following are
just some personal opinions that I'm choosing to share while I have
the chance.

* It'd be a good idea to explicitly mention that lines starting with #
are comments.

* Moving the descriptions into the section headings could save some
space and improve readability.

* As is common in config files and scripts, it could be good to
distinguish between comments used for documentation and lines that are
meant to uncommented by the user. Typically this is done by using a
single # for commented out lines and two or more #s for documentation.

* The "---[ Something ] ---|" seems a bit too graphically busy. I
don't think it aids readability.

If you put all those together with Oswald's suggestions and a few
other minor things, you get something like the template below. Take
from it what you will. :)

Parker


## You MUST wrap all lines at 72 characters.
## Lines starting with a '#' will be ignored.
## See http://techbase.kde.org/Policies/Commit_Policy for more info.
##
## ===[ Subject: Single line, meaningful description shown in logs ]===|

## Leave following line blank and do not remove it.

## ===[ Details: Describes what has changed and explains why ]=========|


## ===[ Fields: Uncomment and edit as applicable ]=====================|
##
## Add Feature to release changelog and optionally close a wish in
## bugs.kde.org as implemented, with optional version.
#FEATURE: <optional bug number>
#FIXED-IN: <release version>
##
## Close a bug in bugs.kde.org as fixed, with optional version.
#BUG: <bug number>
#FIXED-IN: <release version>
##
## Copy commit message to a bug in bugs.kde.org.
#CCBUG: <bug number>
##
## Copy commit message to an email address.
#CCMAIL: <email>
##
## Close a review in reviewboard.kde.org as submitted.
#REVIEW: <review number>
##
## Advise documentation team of user visible changes in the GUI.
#GUI:
##
## Advise Commit Digest team of something interesting.
#DIGEST:
##
## ====================================================================|