A library for computational chemistry.
Development workflow for goChem
goChem is developed in Github using Git. The workflow is a simpler version of the GitFlow model by Vincent Driessen. In particular, the "Hotfix" branch idea comes from there.
The following kinds branches are using for goChem development.
- Feature branches. Where the actual development should happen, hopefully one branch per feature. Code commited to these branches could not work, or even break the whole library.
- Devel branch. When a feature branch has tests implemented for the feature, and passess them, along with the other tests in the library, that branch can be merged into devel.
Devel is the branch that developers and beta-testers are supposed to use. In principle, it should not break, but it could happen. API for features in this branch and not yet in master are allowed.
- Master branch. When devel has shown to work correctly, and it has been without new merges for a while, it can be merged into master. Master is the branch used by the final users. It is expected to work normally and be bug-free. API changes for things in this branch should be kept to an absolute minimun. Every now and then, a release can be tagged in Master.
In summary: Feature branches start and merges from devel, devel merges from feature branches, master merges from devel.
Pull requests: Master does not, ever, accept pull requests. Feature branches, and devel are the only branches that do. Pull requests with new features are never accepted from clone devel branches, only from feature branches. Only bugfixes are accepted from clone devel branches. Some feature branches may not accept pull requests.
If the problem you encounter with goChem is trivial (for instance, a typo in the README file) do not submit a pull request. Simply email the developer.
For more info, e-mail the developer.
Hosted on GitHub Pages — Modified from a theme by orderedlist