Our project gladly welcomes external contributions! We use Pull Requests.
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.
A pull request requires approval from at least one of the maintainers.
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.
/*
* (C) Copyright <holder> <year of first update>[, <year of last update>]
*
* SPDX-License-Identifier: Apache-2.0
*/
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the Developer's Certificate of Origin 1.1 (DCO) - which is the same that the Linux® Kernel community uses to manage code contributions.
When submitting a patch for review, we require that you include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -s
To connect with us, please open an issue or contact one of the maintainers via email. See the MAINTAINERS.md page.
To ensure a working build, please run the full build from the root of the project before submitting your pull request. Pull Requests should include necessary updates to unit tests (src/test/py of the corresponding project)