Changes between Version 1 and Version 2 of Development/CommitMessage


Ignore:
Timestamp:
03/03/09 19:27:59 (11 years ago)
Author:
ibboard
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CommitMessage

    v1 v2  
    11= Commit Messages =
    22
    3 As part of the integration between Subversion and Trac to link bug reports/tickets to source code changes, we have a couple of fairly standard hooks on the repository.
     3As part of the integration between Subversion and Trac to link bug reports/tickets to source code changes, we have a couple of fairly standard hooks on the repository. For information on conventions when referencing tickets and revisions, please read the [wiki:TracConventions Trac Conventions] page.
    44
    55== Format ==
     
    2929References to tickets using any of "references", "refs", "addresses", "re" or "see" followed by a [wiki:WikiFormatting#TracLinks Trac ticket link] (e.g. #1 or ticket:2) leaves the referenced ticket in its current state and [ticket:1#comment:3 appends the commit message].
    3030
     31There are no hard and fast rules, but in general "re #ticket" is generally sufficient.
     32
    3133=== Closing a ticket ===
    3234
    3335If the commit resolves the issue a ticket refers to then the ticket can be closed with the commit message. This is done in a similar manner to commenting on a ticket by using "close", "closed", "closes", "fix", "fixed" or "fixes" followed by a [wiki:WikiFormatting#TracLinks Trac ticket link] (e.g. #1 or ticket:2). This will [ticket:1#comment:10 add the comment to the ticket and close it].
    3436
     37There are no hard and fast rules for which word to use when closing tickets, but there are some rough guidelines that may make sense. "Fixes" seems to be the most appropriate keyword to close bugs/defects since they are broken bits of functionality. Tasks and enhancements seem more like types of tickets that get "Closes" since they're not broken, they're just an issue that needs resolving.
     38
    3539=== Handling multiple tickets ===
    3640