Changes between Version 31 and Version 32 of WorkingConventions/Git


Ignore:
Timestamp:
Aug 15, 2013 1:51:16 PM (20 months ago)
Author:
hvr
Comment:

Restore old commit/ticket referencing syntax

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions/Git

    v31 v32  
    4444  FIX BUILD Use the right find on Windows systems; fixes bindist creation 
    4545}}} 
    46  * If your patch fixes a bug, then include the ticket number in the form "''<verb>'' `#NNNN`" in the commit message, e.g. 
     46 * If your patch addresses or fixes a bug/ticket, then include the ticket number in the form "`#NNNN`" in the commit message, e.g. 
    4747{{{ 
    4848  withMVar family have a bug (fixes #767) 
    4949}}} 
    50  '''''Git will then add a link to the commit from the ticket''''' (as soon as the commit becomes reachable from the `master` HEAD), so that people watching the ticket can see that a fix has been committed, and in the future we can easily find the patch that fixed the ticket.  When navigating the Git history on Trac, you will also be able to jump directly to the ticket from the commit. 
    51  
    52  '''Ticket Referencing Syntax in More Detail''' 
    53  
    54  As stated above, the basic syntax for referencing tickets from commit messages is of the form "''<verb>'' ''<ticket-ref>''". 
    55  
    56  An example for ''<ticket-ref>'' is "`#1234`" or "`#1234 and #1235`", where the latter simply references two tickets at once for convenience. 
    57  
    58  The currently recognized verbs for merely adding a comment to a Trac ticket are 
    59 {{{ 
    60 addressing address re references refs see Trac 
    61 }}} 
    62  (N.B.: Currently, you ''need'' to put a verb in front of the ticket reference in order for the reference to be recognized; this is different from !GitHub) 
    63  
    64  Whereas the verbs recognized for adding a comment *and* closing the ticket are 
    65 {{{ 
    66 close closed closes fix fixed fixes resolve resolves resolved 
    67 }}} 
    68  (N.B. this is the same as [https://help.github.com/articles/closing-issues-via-commit-messages GitHub's issue close syntax]) 
    69  
    70  The ticket referencing syntax is designed in such a way that you can embed ticket references in English sentences. For instance, the following fairly complicated example of what you can do is with a commit message of: 
    71 {{{ 
    72 Changes blah and foo to do this or that 
    73  
    74 Fixes #10 and #12, and refs #13. 
    75 }}} 
    76  This will close #10 and #12, and add a comment to #10, #12, and #13. 
    77  
    78  Please note, that these verbs are only scanned for in the Git repositories associated with this Trac instance (see [source: Source Browser]). It is planned to introduce additional verbs for moving a ticket into the '''merge''' ticket state instead of straight to the '''closed''' state. 
     50 '''''Git will then add a link to the commit from the ticket''''' (as soon as the commit becomes reachable from the `master` HEAD), so that people watching the ticket can see that a fix has been committed, and in the future we can easily find the patch that addressed the ticket.  When navigating the Git history on Trac, you will also be able to jump directly to the ticket from the commit. 
    7951 
    8052== Line endings ==