Our code is publicly available in several repos on GitHub at https://github.com/oneops
We utilize GitHub for issue tracking and contributions. You can contribute in two ways:
- Report an issue or file a feature request as an issue.
- Add features, fix bugs yourself, or contribute your code with a pull request.
Contributing Code or Documentation
For small changes — little bug fixes, correcting typos, and the like — please submit pull requests to any of our projects. For larger changes, we have to ask you to electronically sign a statement that indicates two things:
- You are willingly licensing your contributions under the terms of the open source license of the project that you are contributing to.
- You are legally able to license your contributions as stated.
Once you sign this Contributor License Agreement (the “CLA”), we will be able to merge your contributions and with only the friction that results from the usual technical back-and-forth of a vibrant open source project. More details are on the Sign the CLA page.
Create Pull-Requests on your branch from master and we will review and merge.
The website is the main documentation for OneOps and we welcome issues and pull requests for it as well. If you want to help, check out our documentation guideline.
Code Review Process
Each GitHub pull request will go through 3 step before merge:
- We will execute our automated test cases against the pull request. If the tests failed the pull request will be rejected with comments provided on the failures.
- If tests pass, the OneOps engineering team member will do the review of the changes. Technical communication possible
via github.com pull request page. When ready, your pull request will be tagged with label
Ready For Merge.
- Your patch will be merged into
masterincluding necessary documentation updates and you will be included in
Apache 2.0 License
OneOps uses the Apache 2.0 license and any changes or enhancements have to use the same license.
If you are familiar with OneOps and know the repository that is causing you a problem or if you have a feature request on a specific component, you can file an issue in the corresponding GitHub project. All of our Open Source Software can be found in our GitHub organization.
Otherwise you can file your issue in the OneOps project and we will make sure it gets filed against the appropriate project.
To decrease the back and forth in issues, and to help us get to the bottom of them quickly, we use the issue template below. You can copy/paste this template into the issue you are opening and edit it accordingly.
### Version: [Version of the project installed] ### Environment: [Details about the environment such as the Operating System, cookbook details, etc.] ### Scenario: [What you are trying to achieve and you can't?] ### Steps to Reproduce: [If you are filing an issue, what are the things we need to do to reproduce your problem?] ### Expected Result: [What are you expecting to happen as the consequence of the reproduction steps above?] ### Actual Result: [What actually happens after the reproduction steps?]
Useful GitHub Queries
Contributions go through a review process to improve code quality and avoid regressions. Managing a large number of contributions requires a workflow to provide queues for work such as triage, code review, and merging. A semi-formal process has evolved over the life of the project. Chef maintains this process pending community development and acceptance of an RFC. These queries help track contributions through this process:
- Issues that are not assigned to a team
- Untriaged Issues
- PRs to be Reviewed
- Suitable for First Contribution
Provide Feedback or Contact Us
You can provide feedback or contact us by sending email to email@example.com or by using one of the corresponding OneOps Slack channels : #admin, #devel, or #user.