Skip to content

Commit ecd44c1

Browse files
committed
Updated PR checklist
1 parent bc1eae8 commit ecd44c1

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

docs/pull_request_template.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ Below is a simple checklist but please do not hesitate to ask for assistance!
44

55
- [ ] Read our [Contributing Guide](https://stumpy.readthedocs.io/en/latest/Contribute.html)
66
- [ ] Referenced a Github issue (or create one if one doesn't already exist)
7-
- [ ] Left a meaningful comment on the original Github issue to discuss the detailed approach for your contribution
8-
- [ ] Forked, cloned, and checkedout the newest version of the code
7+
- [ ] Read and reviewed all of the comments in the Github issue that you've referenced (along with cross-referenced issues/pull requests) to ensure that the issue still requires a pull request
8+
- [ ] Checked that the issue has not already been assigned to anybody else or is already being addressed in another pull request
9+
- [ ] Left a meaningful comment on the original Github issue to discuss the detailed approach for your contribution and received confirmation from the maintainers before proceeding with this pull request
10+
- [ ] Forked, cloned, and checked out the newest version of the code
911
- [ ] Created a new branch
1012
- [ ] Made necessary code changes
1113
- [ ] Installed `black` (i.e., `python -m pip install black` or `conda install -c conda-forge black`)
1214
- [ ] Installed `flake8` (i.e., `python -m pip install flake8` or `conda install -c conda-forge flake8`)
1315
- [ ] Installed `pytest-cov` (i.e., `python -m pip install pytest-cov` or `conda install -c conda-forge pytest-cov`)
1416
- [ ] Ran `black --exclude=".*\.ipynb" --extend-exclude=".venv" --diff ./` in the root stumpy directory
1517
- [ ] Ran `flake8 --extend-exclude=.venv ./` in the root stumpy directory
16-
- [ ] Ran `./setup.sh dev && ./test.sh` in the root stumpy directory
18+
- [ ] Ran `./setup.sh dev && ./test.sh` in the root stumpy directory and ensured that all tests are passing locally
19+
- [ ] Check this box if AI code assistance was used to generate 15%+ of the code in this pull request
20+
21+
Please do not commit any code to avoid/circumvent a failing test and, instead, engage in a discussion (below) to determine the best course of action.
22+
23+
Only request a review **after** the checklist above is fully completed!

0 commit comments

Comments
 (0)