Dogma

Dogma

This is a list of simple beliefs which everyone working on this project must adhere to. They are negotiable but until changed by the group, they must be followed.

All Hail The Build

The build is the heart of the project. If the build is broken, the project is broken. The build will break from time to time. If the build is broken, it is everyone's responsibility to fix it. As a last resort to fix the build, code will be reverted. To prevent your wonderful code from being reverted, always monitor the start of the build before committing.

This brings us neatly to our commandments.

Commandments

Thou Shalt Commit Often

The simplest command but the most effective. Committing often will minimize the risk of clashing with other people's work. Big commits are more likely to break the build, I speak from experience. If the build breaks and cannot be repaired quickly (5 minutes), the commit will be reverted. Ye have been warned.

Thou Shalt Update Often

Perform and update before a commit. If you see anything that may destabilize the build, run the local tests first and fix any issues. If all is well, then commit.

Thou Shalt Not Clobber Other's Work

If you attempt to commit work and you get a warning that the file has been altered, it is your responsibility to merge your changes with theirs on your machine. This will prevent the build from breaking. If you commit and update often this should be less of a risk.