Skip to content

Commit 41f1973

Browse files
[MNT] Add Pull Request template (#241)
This PR adds a [.github/PULL_REQUEST_TEMPLATE.md] to standardize contributions. It ensures that all future PRs include necessary details like a summary of changes and a compliance checklist. Fixes #83 --------- Co-authored-by: PGijsbers <p.gijsbers@tue.nl>
1 parent 7de0020 commit 41f1973

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Description
2+
3+
Please include a summary of the change and include relevant motivation and context. Mention any related issues, if this fixes an issue, include the text "Fixes: #..." with the appropriate issue number(s).
4+
5+
# Checklist
6+
7+
_Please check all that apply. You can mark items as N/A if they don't apply to your change._
8+
9+
- [ ] I have performed a self-review of my own code
10+
- [ ] I have commented my code in hard-to-understand areas, and provided or updated docstrings as needed
11+
- [ ] I have made corresponding changes to the documentation pages (`/docs`)
12+
- [ ] I have added tests that cover the changes
13+
- [ ] Tests pass locally.
14+
15+
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)