wiki:CommitPolicy

Version 1 (modified by Dominic Hargreaves, 16 years ago) (diff)

initial portion. To complete.

Openguides commit policy

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 Subversion, but also relevant for those submitting patches via the mailing list or Trac.

Code style

Indentation

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:

set tabstop=4
set expandtab

Before committing

Before 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.

When to commit

Sometimes the release manager will call the tree frozen to allow a release to happen. No changes to the tree should be made when the tree is frozen except by the release manager. I intend freeze points to be shown on the Trac roadmap.

How to commit