Coding Standards
As a research driven programming group, we must satisfy research requirements as well as maintain high standards in programming practice. This page explains the standards and practices we will follow to the best of our abilities.
Git is a powerful version control system, but with power comes responsibility. In general, we will attempt to adhere to the branching model outlined here.
We aim to have the master branch contain release level code, while the scoop-develop branch contain or organize the new features being added. Hotfixes can be applied to the master branch and will be drawn back into the scoop-develop branch as needed.
The scoop-develop branch will only be merged into the master branch when the build is stable and the features being developed are in a deployable state. For code which requires external libraries, should they require libraries from scoophealth, we will want these libraries to ultimately be drawn from the master branch.
As we are working with multiple open-source projects, the coding style and conventions may vary inbetween projects. However, we will attempt to outline the conventions we will adhere to for each project as well as general practices that should be followed across all projects.
Programming is one thing. Programming well is another. In order for us to maintain high standards in our code, we will use an internal Gerrit in order to review significant code changes.
To be added…
SCOOP is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
