diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..90ad822 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +## Summary + + + +## Test plan + + + +--- + +> [!IMPORTANT] +> Most code in `ionq_core/` is auto-generated. Do not edit files under `ionq_core/api/`, +> `ionq_core/models/`, or `ionq_core/client.py`, `errors.py`, `types.py` directly. +> See [CONTRIBUTING.md](../CONTRIBUTING.md#code-structure) for details. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7285979..c88033e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,6 +61,12 @@ uvx openapi-python-client==0.28.3 generate \ ## Pull requests - Keep PRs focused on a single change. -- Add tests for new hand-written code. +- Add tests for new hand-written code. CI enforces 100% branch coverage on all hand-written code. - CI must pass before merging (lint, tests, type check, generated code staleness check). - The generated code staleness check on PRs verifies that `ionq_core/` matches what the generator produces. If it fails, regenerate and commit the result. + +## License + +By submitting a pull request, you represent that you have the right to license your +contribution to IonQ and the community, and agree that your contribution is licensed +under the [Apache License, Version 2.0](LICENSE).