# Development contributions

We like pull requests from everyone. By participating in this project, you agree to follow the code of conduct (opens new window).

  • We use the pre-commit (opens new window) system to identify simple issues before submission to code review. Install it with pip install pre-commit.
  • Fork the development branch (opens new window), then clone the repo.
  • Run pre-commit install to set up the Git hook scripts.
  • Make your modification.
  • Review your code, build it.
  • Test it locally on your hardware configuration.
  • Create a pull request.
  • Verify the GitHub Actions CI results.
  • Request for review.
  • We may suggest some changes, improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

# Developer Certificate Of Origin

    By making a contribution to this project, I certify that:

    (a) The contribution was created in whole or in part by me and I
        have the right to submit it under the open source license
        indicated in the file; or

    (b) The contribution is based upon previous work that, to the best
        of my knowledge, is covered under an appropriate open source
        license and I have the right under that license to submit that
        work with modifications, whether created in whole or in part
        by me, under the same open source license (unless I am
        permitted to submit under a different license), as indicated
        in the file; or

    (c) The contribution was provided directly to me by some other
        person who certified (a), (b) or (c) and I have not modified
        it.

    (d) I understand and agree that this project and the contribution
        are public and that a record of the contribution (including all
        personal information I submit with it, including my sign-off) is
        maintained indefinitely and may be redistributed consistent with
        this project or the open source license(s) involved.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

This Developer Certificate Of Origin (DCO) was adopted on February 26, 2022.

The text of this license is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License (opens new window). It is based on the Linux Developer Certificate Of Origin (opens new window).

To accept the DCO it is required to put a x between [ ] on [ ] I accept the DCO in the PR template when submitting it. The [ ] is an opt-in box, so you have to manually accept it.