From dde89a6aa97f30d8c5821e8e25435884f9df6993 Mon Sep 17 00:00:00 2001 From: Tennessee Leeuwenburg Date: Wed, 18 Feb 2026 17:09:38 +1100 Subject: [PATCH] Add pull request template --- .github/pull_request_template.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..d652109f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +Please review your pull request for the following steps. Feel free to delete anything that is not applicable to your pull request. + +## Getting Started +- [ ] If there is not an existing issue, raise a new issue +- [ ] In the issue, state that you are intending to work on a contribution. This gives everyone involved the opportunity to discuss the best way forward. + +## Docstrings +- [ ] Docstrings complete and follow Napoleon (google) style + +## Test Coverage +- [ ] All new code is covered by unit tests + +## Documentation +- [ ] Documentation is updated as required + +## Final Checks: + + - [ ] If no generative AI was used, then tick this box + +Alternatively, if generative AI was used, then confirm you have: + + - [ ] Attributed any generative AI (such as GitHub Copilot) that was used in this PR. See [our contributing guide](https://github.com/ACCESS-Community-Hub/PyEarthTools?tab=contributing-ov-file) for more information. + - [ ] Included the name and version of the tool or system in the pull request + - [ ] Described the scope of that use + +Finally, + + - [ ] Mark the PR as ready to review. Note - we encourage you to ask for feedback at the outset or at any time during the work.