From 5f86b0f004a351ca173f85abb0c2cc68e42e459c Mon Sep 17 00:00:00 2001 From: Meg Schwamb Date: Sat, 17 Feb 2024 21:12:24 +0000 Subject: [PATCH] Update pull_request_template.md Fixes #30 - uses simplified Sorcha PR template --- .github/pull_request_template.md | 68 ++++---------------------------- 1 file changed, 8 insertions(+), 60 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 76e043c..3b24cad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,63 +1,11 @@ - +## Review Checklist for Source Code Changes -## Change Description - -- [ ] My PR includes a link to the issue that I am addressing - - - -## Solution Description - - - - -## Code Quality -- [ ] I have read the Contribution Guide -- [ ] My code follows the code style of this project -- [ ] My code builds (or compiles) cleanly without any errors or warnings -- [ ] My code contains relevant comments and necessary documentation - -## Project-Specific Pull Request Checklists - - -### Bug Fix Checklist -- [ ] My fix includes a new test that breaks as a result of the bug (if possible) -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### New Feature Checklist -- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### Documentation Change Checklist -- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) - -### Build/CI Change Checklist -- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this -- [ ] If this is a new CI setup, I have added the associated badge to the README - - - -### Other Change Checklist -- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html). -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) +- [ ] Does pip install still work? +- [ ] Have you written a unit test for any new functions? +- [ ] Do all the units tests run successfully? +- [ ] Does adler run successfully on a test set of input files/databases? +- [ ] Have you used black on the files you have updated to confirm python programming style guide enforcement?