Skip to content

Commit 33e86bc

Browse files
[MNT] Enhance PR template with detailed checklist items (#270)
Updated the pull request template to clarify self-review and testing requirements. The main motivation was that I prefer bots to self-identify. It's not that hard to spot typically, and correct changes might normally still be accepted, but it can help with prioritization or managing expectation on response times. --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
1 parent f758b26 commit 33e86bc

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,19 @@ Please include a summary of the change and include relevant motivation and conte
66

77
_Please check all that apply. You can mark items as N/A if they don't apply to your change._
88

9-
- [ ] I have performed a self-review of my own code
9+
Always:
10+
- [ ] I have performed a self-review of my own pull request to ensure it contains all relevant information, and the proposed changes are minimal but sufficient to accomplish their task.
11+
12+
Required for code changes:
13+
- [ ] Tests pass locally
1014
- [ ] I have commented my code in hard-to-understand areas, and provided or updated docstrings as needed
15+
- [ ] Changes are already covered under existing tests
16+
- [ ] I have added tests that cover the changes (only required if not already under coverage)
17+
18+
If applicable:
1119
- [ ] I have made corresponding changes to the documentation pages (`/docs`)
12-
- [ ] I have added tests that cover the changes
13-
- [ ] Tests pass locally.
20+
21+
Extra context:
22+
- [ ] This PR and the commits have been created autonomously by a bot/agent.
1423

1524
nb. If tests pass locally but fail on CI, please try to investigate the cause. If you are unable to resolve the issue, please share your findings.

0 commit comments

Comments
 (0)