Skip to content

Commit 1953eab

Browse files
committed
Update PR template
1 parent fba4fd6 commit 1953eab

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
3+
_Add a comprehensive description of proposed changes_
4+
5+
_List associated issue number(s) if exist(s): #6 (for example)_
6+
7+
_Documentation PR (if needed): #1340 (for example)_
8+
9+
---
10+
11+
PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
12+
This approach ensures that reviewers don't spend extra time asking for regular requirements.
13+
14+
You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
15+
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).
16+
17+
Checklist to comply with **before moving PR from draft**:
18+
19+
**PR completeness and readability**
20+
21+
- [ ] I have reviewed my changes thoroughly before submitting this pull request.
22+
- [ ] I have commented my code, particularly in hard-to-understand areas.
23+
- [ ] 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.
24+
- [ ] 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)_.
25+
- [ ] I have added a respective label(s) to PR if I have a permission for that.
26+
- [ ] I have resolved any merge conflicts that might occur with the base branch.
27+
28+
**Testing**
29+
30+
- [ ] I have run it locally and tested the changes extensively.
31+
- [ ] All CI jobs are green or I have provided justification why they aren't.
32+
- [ ] I have extended testing suite if new functionality was introduced in this PR.

0 commit comments

Comments
 (0)