1: =GT=, followed by a ticket number (starting with a pound so gittrac will recognize it), which indicates that this commit is related to a particular ticket. 1: =GT:Fixed=, followed by a ticket number (again, starting with a pound); this implies =GT= and indicates that this commit resolves a particular ticket. 1: =UpgradeNote= includes a description of a backwards-compatibility issue introduced by this commit (e.g. "This commit changes the wire protocol for the pony server.") -1: =VersionHistory= includes a plain-text version history entry related to this commit. -1: =VersionHistory:MD= includes a Markdown-formatted version history entry related to this commit. -1: =VersionHistory:None= indicates that this commit has no associated version history -1: =VersionHistory:Formatted= includes a LaTeX version history entry for this commit +1: =Doc=, a summary of the state of documentation for this item. Used to communicate with the wrangler. +1: =VersionHistory=, a summary of the state of the version history for this item. Used to communicate with the wrangler +{section: Doc glosses, AKA helping the wrangler.} + +Glosses with the tag ===VersionHistory=== or ===Doc=== are intended make the wranglers job easier. Please make sure to include the ticket number somewhere in the commit message for commits that have {quote: VersionHistory} or Doc glosses. The text following the VersionHistory/Doc tag is intended to let the wrangler know what the state of associated documentation is, so please use one or more of the following: + +1: =None= or =NA=, there is not and should not be a version history item or documentation for this commit. +1: =Pending=, version history is needed, but has not yet been done +1: =VH Complete=, version history has been completed +1: =Doc Pending=, version history is completed, but other documetation is pending +1: =All Complete=, version history and documetation is completed + +It is not necessary that _every_ commit associated with a ticket have a =Doc= or =VersionHistory= gloss, but at least one commit for each ticket should. {section: Installing a commit message template} @@ -40,7 +49,7 @@ # #===GT=== #1234 #===GT:Fixed=== #1234 - #===VersionHistory=== + #===Doc=== NA, Pending, Doc Pending, VH/All Complete #===UpgradeNote=== Then, tell =git= where to find this template: