Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Summary

<!-- What does this PR do and why? -->

## Test plan

<!-- How did you verify this change works? -->

---

> [!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.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).