Is this page helpful?

Pull Request Workflow#

We welcome contributions. Follow the steps below.

Pull Request Process#

  1. Fork the upstream repository and clone your fork.

  2. Create a branch from gen_v2, make changes, and add or update tests.

  3. Run checks: ./scripts/dev.sh test && ./scripts/dev.sh pre-commit (or equivalent).

  4. Push to your fork and open a Pull Request into the upstream branch you target.

  5. Address review feedback. Maintainers will merge after review (and any required manual verification if CI is not yet in place).

Sign-Off and DCO#

We require that all contributors sign off on their commits (Developer’s Certificate of Origin). Commits that are not signed off will not be accepted.

To sign off on a commit:

git commit -s -m "Your message"

This appends a line such as:

Signed-off-by: Your Name <your@email.com>

Developer’s Certificate of Origin 1.1#

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.