diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c36428b300..1d12aa02eb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,24 @@ -[Description of PR] + + +## Summary + +[Describe what this PR changes and why, in your own words.] + +## For reviewers + +[What would you most value a second look at? What are you already confident in? For a refactor, say whether behavior is meant to be unchanged.] + +## Author attestation + +- [ ] I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct. + +AI coding assistance is welcome, but a human must be the author and is responsible for the contents of the PR. The description and any review responses must be in your own words. Please read [AI-assisted contributions](https://zarr.readthedocs.io/en/stable/contributing/#ai-assisted-contributions) before opening. + +## TODO -TODO: * [ ] Add unit tests and/or doctests in docstrings * [ ] Add docstrings and API docs for any new/modified user-facing classes and functions * [ ] New/modified features documented in `docs/user-guide/*.md`