Changes between Version 1 and Version 2 of CommitPolicy


Ignore:
Timestamp:
Nov 22, 2005, 9:26:52 PM (16 years ago)
Author:
Dominic Hargreaves
Comment:

Finish off

Legend:

Unmodified
Added
Removed
Modified
  • CommitPolicy

    v1 v2  
    11== Openguides commit policy ==
    22
    3 In order to ensure that OpenGuides development happens in a controlled way and with peer review, the following points need to be adhered to when contributing code (this is especially true for people with direct commit access to [wiki:Subversion Subversion], but also relevant for those submitting patches via the mailing list or Trac.
     3In order to ensure that OpenGuides development happens in a controlled way and with peer review, the following points need to be adhered to when contributing code (this is especially true for people with direct commit access to [wiki:Subversion Subversion], but also relevant for those submitting patches via the mailing list or Trac).
    44
    55=== Code style ===
     
    2424=== How to commit ===
    2525
     26See [wiki:Subversion Subversion] for details of how to access the repository. Remember, you should only be working in the trunk for the time being.
     27
     28Make sure that changes are committed in a logical fashion. If you are making multiple unrelated changes to files, don't commit them all at once. Subversion (unlike CVS) has the notion of a changeset, so if you commit in this way all the changes will be grouped logically together and be easy to review. This includes the change to the Changes file. If you need to reformat a file, do so as a separate commit.
     29
     30=== Automating Trac with Subversion log messages ===
     31
     32When you commit a change that fixes a issue reported in a Trac ticket you can (and should, if possible) close the ticket automatically by including the string: "closes #nn" (where nn is the ticket number) in the log message. This will automatically close the ticket with a reference to the changeset. Note that this is a change from the way bugs were handled in RT (they were only closed when in a released version) but this functionality is too useful to not make use of. Hopefully we will get back to a release early, release often mode of operation so this won't hamper us too much.
     33
     34You can also just refer to a ticket, which means that hyperlinks between the two will appear but the status will not change. The full specification of this functionality is as follows:
     35
     36Commands can appear as:
     37
     38{{{
     39command #1
     40command #1, #2
     41command #1 & #2
     42command #1 and #2
     43}}}
     44
     45You can have more than one command in a log message. The supported commands are:
     46
     47|| close, closed, closes, fix, fixed, fixes, || Closes the ticket ||
     48|| addresses, re, references, refs, see || References the ticket ||
     49
     50=== People ===
     51
     52The following currently have commit access to OpenGuides. Usernames refer to the identies within both Subversion and Trac:
     53
     54|| Username || Name || Role ||
     55|| dom || Dominic Hargreaves || Release manager, bug triage ||
     56|| earle || Earle Martin || Developer ||