Changes between Version 7 and Version 8 of CommitPolicy


Ignore:
Timestamp:
Nov 29, 2005, 4:14:22 PM (16 years ago)
Author:
Ivor Williams
Comment:

Damian's book and section on patches

Legend:

Unmodified
Added
Removed
Modified
  • CommitPolicy

    v7 v8  
    55=== Code style ===
    66
     7A recommended programming style is given in Damian Conway's book [http://www.oreilly.com/catalog/perlbp/ Perl Best Practices]. --ivorw (I have a copy)
     8
    79==== Indentation ====
    810
    9 Follow the existing indentation style which is 4 spaces. Literal tabs are not used in OpenGuides development (if you are using vim, the following in your ~/.vimrc may help):
     11For Perl code, follow the existing indentation style which is 4 spaces. Literal tabs are not used in OpenGuides development (if you are using vim, the following in your ~/.vimrc may help):
    1012
    1113{{{
     
    1416}}}
    1517
     18For templates, we use two spaces for each indent level.
     19
    1620=== Before committing ===
    1721
    1822Before committing changes to the repository, you should ensure that all tests continue to pass (and if you have added more code, that you include new tests for it). If you're adding a new feature it's probably best to have discussed things first on the dev mailing list or on an enhancement ticket within Trac. You should most probably have an open ticket for the issue in any case.
    1923
    20 I encourage committers to attach patches to tickets before committing too, to allow for some initial code review, for non-trivial changes.
     24=== Submitting patches ===
     25
     26I encourage committers to attach patches to tickets before committing too, to allow for some initial code review, for non-trivial changes. Patches can be submitted by people without commit rights.
     27
     28Please use unified diff format, and give the resulting file an extension of .patch which allows trac to browse it sensibly. This can be done easily with subversion:
     29
     30{{{
     31cd openguides
     32svn diff trunk >ticket_123.patch
     33}}}
     34
     35Upload your patch to the ticket as an attachment. Keep the same name if you have a new revision of the patch which supersedes a previous upload. In the comment to go with the upload, include either the changeset number e.g. [789], for which your patch is made against, or the OpenGuides version number if the patch was made against a CPAN download.
     36
     37Keep your patch up to date with svn update every time the trunk changes (remember to resolve any conflicts).
    2138
    2239=== When to commit ===