Changes between Version 13 and Version 14 of CommitPolicy


Ignore:
Timestamp:
May 25, 2007, 3:06:54 PM (14 years ago)
Author:
Kake
Comment:

Tidy up a bit, add question.

Legend:

Unmodified
Added
Removed
Modified
  • CommitPolicy

    v13 v14  
    55=== Code style ===
    66
    7 A recommended programming style is given in Damian Conway's book [http://www.oreilly.com/catalog/perlbp/ Perl Best Practices]. --ivorw (I have a copy)
     7A recommended programming style is given in Damian Conway's book [http://www.oreilly.com/catalog/perlbp/ Perl Best Practices]. --IvorWilliams
     8
     9Question from KakePugh: can you be more specific about what you mean here?
    810
    911==== Indentation ====
    1012
    11 For 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):
     13An indent is four spaces in Perl code, two spaces in templates.  Do not use literal tabs.
     14
     15If you are using vim, the following in your ~/.vimrc may help:
    1216
    1317{{{
     
    1620}}}
    1721
    18 Literal tabs are also straighened out by perltidy (see [http://search.cpan.org/~shancock/Perl-Tidy/ Perl::Tidy]).
     22Literal tabs can also be straightened out with perltidy (see [http://search.cpan.org/~shancock/Perl-Tidy/ Perl::Tidy]).
    1923
    20 For templates, we use two spaces for each indent level.
     24==== Function and variable names ====
     25
     26Use lowercase and underscores, not CamelCase.  For example, my_method_name rather than myMethodName.
    2127
    2228=== Before committing ===
     
    5359When 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.
    5460
    55 Could someone give me an actual example of what you would type in order to give an informative commit message ''and'' auto-close a ticket, please?  I can't get it to work. --KakePugh
     61NB this doesn't work at the moment (confirmed on the mailing list by DominicHargreaves) --KakePugh
    5662
    5763You 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: