From d3414639133a03b7c674ec0bde469336e9a3ff39 Mon Sep 17 00:00:00 2001 From: Alex Dewar Date: Thu, 29 Aug 2024 18:06:03 +0100 Subject: [PATCH] Add pull request template I've taken this from our standard Python template. Closes #41. --- .github/PULL_REQUEST_TEMPLATE.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 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 0000000..324a644 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +# Description + +_Please include a summary of the change and which issue is fixed (if any). Please also +include relevant motivation and context. List any dependencies that are required for +this change._ + +Fixes # (issue) + +## Type of change + +- [ ] Documentation (non-breaking change that adds or improves the documentation) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Optimization (non-breaking, back-end change that speeds up the code) +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Breaking change (whatever its nature) + +## Key checklist + +- [ ] All tests pass (eg. `pytest`) +- [ ] The documentation builds and looks OK (eg. `mkdocs`) +- [ ] Pre-commit hooks run successfully (eg. `pre-commit run --all-files`) + +## Further checks + +- [ ] Code is commented, particularly in hard-to-understand areas +- [ ] Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))