Skip to content

Commit 16ed9a2

Browse files
Merge pull request #129 from BrandonGroth/github_pr_template
test: Updated PR template for more information on testing
2 parents 578759f + 3a9e781 commit 16ed9a2

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

.github/pull_request_template.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,26 @@
44

55
<!-- Please summarize the changes -->
66

7-
### Related issue number
7+
### Related issues or PRs
88

9-
<!-- For example: "Closes #1234" -->
9+
<!-- For example: "Closes #1234" or "Fixes bug introduced in #5678 -->
1010

11-
### How to verify the PR
11+
### (Optional) List any documentation or testing added
1212

13-
<!-- Please provide instruction or screenshots on how to verify the PR.-->
13+
<!-- Describe which features were documented/tested -->
1414

15-
### Was the PR tested
15+
### (Optional) How to verify the contribution
1616

17-
<!-- Describe how PR was tested -->
18-
- [ ] I have added >=1 unit test(s) for every new method I have added.
19-
- [ ] I have ensured all unit tests pass
17+
<!-- Provide instructions on how to verify your contribution if unit tests do not provide coverage -->
18+
19+
### Checklist for passing CI/CD:
20+
21+
<!-- Mark completed tasks with "- [x]" -->
22+
- [ ] All commits are signed showing "Signed-off-by: Name \<[email protected]\>" with `git commit -signoff` or equivalent
23+
- [ ] PR title and commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
24+
- [ ] Contribution is formatted with `tox -e fix`
25+
- [ ] Contribution passes linting with `tox -e lint`
26+
- [ ] Contribution passes spellcheck with `tox -e spellcheck`
27+
- [ ] Contribution passes all unit tests with `tox -e unit`
28+
29+
Note: CI/CD performs unit tests on multiple versions of Python from a fresh install. There may be differences with your local environment and the test environment.

0 commit comments

Comments
 (0)