Development and Collaboration Policy

Overview

Starting Sunday, March 18, 2012, Dormbase is changing to a github pull-request development model. Development should no longer occur on the master branch in dormbase/dormbase. Each developer should instead fork the repository, make changes, and then issue a pull request. The Dormbase administrative team is responsible for integrating these pull requests into the master branch.

Policy for pull requests

Code submitted for pull requests must be reviewed (with github comments) by at least two members of the Dormbase team. Code submitted for review should be fully commented and documented, with appropriate docstrings (or doxygen, or javadoc).

Policy for the master branch

The master branch has previously been considered unstable. With the new development policy, the master branch is now considered semi-stable. Releases will be tags on the master branch. It is expected that installing from HEAD should almost always work cleanly.