From 8328b725a7b8dd35fe9750b6f797d20e647ef53f Mon Sep 17 00:00:00 2001
From: Meg Schwamb <megan.schwamb@gmail.com>
Date: Tue, 23 Apr 2024 23:38:09 +0100
Subject: [PATCH] Update pull_request_template.md

update PR template to match sorcha repository
---
 .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..757970d 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,63 +1,11 @@
-<!-- 
-Thank you for your contribution to the repo :)
+Fixes # .
 
-Pull Request (PR) Instructions:
-Provide a general summary of your changes in the Title above. Fill out each section of the template, and replace the space with an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! Once you are satisfied with the pull request, click the "Create pull request" button to submit it for review.
+Describe your changes.
 
-Before submitting this PR, please ensure that your input and responses are entered in the designated space provided below each section to keep all project-related information organized and easily accessible.
- 
-How to link to a PR:
-https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue 
--->
+## Review Checklist for Source Code Changes
 
-## Change Description
-<!--- 
-Describe your changes in detail. In your description, you should answer questions like "Why is this change required? What problem does it solve?".
-
-If it fixes an open issue, please link to the issue here. If this PR closes an issue, put the word 'closes' before the issue link to auto-close the issue when the PR is merged.
--->
-- [ ] My PR includes a link to the issue that I am addressing
-
-
-
-## Solution Description
-<!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented -->
-
-
-
-## 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
-<!--- Please only use the checklist that apply to your change type(s) -->
-
-### 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
-
-<!-- ### Version Change Checklist [For Future Use] -->
-
-### 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 Sorcha Add-ons 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?