Skip to content

Commit 37fe5a7

Browse files
authored
Update PR template (#187)
1 parent 1103aad commit 37fe5a7

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

.github/pull_request_template.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
11
## Description
22

3-
_Add a comprehensive description of proposed changes_
3+
<!--
4+
Add a comprehensive description of proposed changes
45
5-
_List associated issue number(s) if exist(s): #6 (for example)_
6+
List associated issue number(s) if exist(s)
67
7-
_Documentation PR (if needed): #1340 (for example)_
8+
List associated documentation PR(s) if needed
9+
-->
810

911
---
1012

11-
PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
13+
<!--
14+
PR should start as a draft, then move to ready for review state
15+
after CI is passed and all applicable checkboxes are closed.
1216
This approach ensures that reviewers don't spend extra time asking for regular requirements.
1317
1418
You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
19+
-->
1520

16-
Checklist to comply with **before moving PR from draft**:
21+
<details>
22+
<summary>Checklist:</summary>
1723

18-
**PR completeness and readability**
24+
**Completeness and readability**
1925

20-
- [ ] I have reviewed my changes thoroughly before submitting this pull request.
2126
- [ ] I have commented my code, particularly in hard-to-understand areas.
22-
- [ ] I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
23-
- [ ] Git commit message contains an appropriate signed-off-by string _(see [CONTRIBUTING.md](https://github.com/intel/scikit-learn-intelex/blob/main/CONTRIBUTING.md#pull-requests) for details)_.
24-
- [ ] I have added a respective label(s) to PR if I have a permission for that.
27+
- [ ] I have updated the documentation to reflect the changes or created a separate PR with updates and provided its number in the description, if necessary.
28+
- [ ] Git commit message contains an appropriate signed-off-by string _(see [CONTRIBUTING.md](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/CONTRIBUTING.md#pull-requests) for details)_.
2529
- [ ] I have resolved any merge conflicts that might occur with the base branch.
2630

2731
**Testing**
2832

2933
- [ ] I have run it locally and tested the changes extensively.
3034
- [ ] All CI jobs are green or I have provided justification why they aren't.
3135
- [ ] I have extended testing suite if new functionality was introduced in this PR.
36+
37+
</details>

0 commit comments

Comments
 (0)