Coding style
The style guide lists the coding conventions used in this project.
Subversion
The IDLdoc project uses a "branch-when-needed" system described in the Subversion Best Practices.
Users commit their day-to-day work on /trunk.
- /trunk must compile and pass regression tests at all times. Committers who violate this rule are publically humiliated.
- A single commit (changeset) must not be so large so as to discourage peer-review.
- If rules 1. and 2. come into conflict (i.e. it's impossible to make a series of small commits without disrupting the trunk), then the user should create a branch and commit a series of smaller changesets there. This allows peer-review without disrupting the stability of /trunk.
Pros: /trunk is guaranteed to be stable at all times. The hassle of branching/merging is somewhat rare.
Cons: Adds a bit of burden to users' daily work: they must compile and test before every commit.
Attachments
- styleguide.pdf (57.3 kB) -
IDL coding style guide
, added by mgalloy on 01/23/08 12:44:29.
