When contributing to this repository, please first discuss the change you wish to make via the issue tracker before making a pull request.
Please note we have a code of conduct, please follow it in all your interactions with the project.
The pyadi-iio repository is a aggregate of a module and separate applications/programs/examples as well as doc which use that module:
- All components are licensed under the ADI-BSD license found in the root of the repository
Any pull requests will be covered by this license.
- Commit message includes a "Signed-off-by: [name] < email >" to the commit message. This ensures you have the rights to submit your code, by agreeing to the Developer Certificate of Origin. If you can not agree to the DCO, don't submit a pull request, as we can not accept it.
- Commit should be "atomic", ie : should do one thing only. A pull requests should only contain multiple commits if that is required to fix the bug or implement the feature.
- Commits should have good commit messages. Check out The git Book for some pointers, and tools to use.
- All code should be formatted using the recommended tools in the doc and pass all linter checks
- All currently passing test should pass that run within the CI environment
- Make a fork, if you are not sure on how to make a fork, check out GitHub help
- Make a Pull Request, if you are not sure on how to make a pull request, check out GitHub help
- Before a Pull Request can be merged, it must be reviewd by at least one reviewer, and tested on as the target hardware(s). The hardware used to test a commit should be noted in the Pull Request.