Here's a quick rundown of how to contribute to this project.
We develop on a private branch internally at OOSMOS. With each new release, we update this Github project with the changes from the internal repository. External pull requests are cherry-picked into our repository and then are included in the next public release.
We welcome your pull requests!
- Fork the repository and create your branch from
master
. - Add test(s) if necessary -- self-checking, if possible.
- Provide documentation if you've added an API.
- Ensure that existing examples still run -- at least those in directories
Basic
,Ortho
, andSync
on either Windows or Linux. - If you haven't already, complete the Contributor License Agreement ("CLA").
In order to accept your pull request, we need you to submit a CLA. You only need to do this once.
Complete your CLA here: Contributor License Agreement.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
OOSMOS documentation is currently maintained only on
the oosmos.com website. Any additions, clarifications
or suggestions to the documentation can be submitted via email directly to [email protected]
.
By contributing to OOSMOS, you agree that your contributions will be licensed under both its GPLv2 license as well as its Commercial License.