This library is open source (Apache License 2.0) and we actively seek any community contibutions for code, suggestions and documentation. This page details a few notes, workflows and suggestions for how to make contributions most effective and help us all build better software - please give them a read before working on any contributions.
This library has been created under the Apache License 2.0, which will cover any contributions you may make to this project. Please familiarise yourself with the terms of the license.
Additionally, this library uses the Harmony CLA agreement. It’s the easiest way for you to give us permission to use your contributions. In effect, you’re giving us a license, but you still own the copyright — so you retain the right to modify your code and use it in other projects. Please sign the CLA here before making any contributions.
We have adopted the Ubuntu Code of Conduct.
The workflow for contributing code is as follows:
- Submit a bug to explain the need for and track the change.
- Create a branch on your fork of the repo with your changes, including a unit test covering the new or modified code.
- Submit a PR. The PR description should include a link to the bug on Launchpad.
- Update the Launchpad bug to include a link to the PR and the
review-neededtag. - Once reviewed and merged, the change will become available on the edge channel and assigned to an appropriate milestone for further release according to priority.
Documentation for this project is currently maintained in the README.