Skip to content

Commit ff21913

Browse files
Update PR template to be concise with checklist (#73)
This PR simplifies PR template to have 3 sections, "Description", "Issue" and "Checklist". The check list provides overview on tests and documentation with respect to changes that are part of this PR. ## Issue There is no issue created for this requirement. Authors: - Ramakrishnap (https://github.com/rgsl888prabhu) Approvers: - James Lamb (https://github.com/jameslamb) URL: #73
1 parent 4c92bf8 commit ff21913

File tree

1 file changed

+21
-35
lines changed

1 file changed

+21
-35
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,27 @@ Thank you for contributing to cuOpt :)
44
55
Here are some guidelines to help the review process go smoothly.
66
7-
1. Please write a description in this text box of the changes that are being
8-
made.
9-
10-
2. Please ensure that you have written units tests for the changes made/features
11-
added.
12-
13-
3. If you are closing an issue please use one of the automatic closing words as
14-
noted here: https://help.github.com/articles/closing-issues-using-keywords/
15-
16-
4. If your pull request is not ready for review but you want to make use of the
17-
continuous integration testing facilities please label it with `[WIP]`.
18-
19-
5. If your pull request is ready to be reviewed without requiring additional
20-
work on top of it, then remove the `[WIP]` label (if present) and replace
21-
it with `[REVIEW]`. If assistance is required to complete the functionality,
22-
for example when the C/C++ code of a feature is complete but Python bindings
23-
are still required, then add the label `[HELP-REQ]` so that others can triage
24-
and assist. The additional changes then can be implemented on top of the
25-
same PR. If the assistance is done by members of the rapidsAI team, then no
26-
additional actions are required by the creator of the original PR for this,
27-
otherwise the original author of the PR needs to give permission to the
28-
person(s) assisting to commit to their personal fork of the project. If that
29-
doesn't happen then a new PR based on the code of the original PR can be
30-
opened by the person assisting, which then will be the PR that will be
31-
merged.
32-
33-
6. Once all work has been done and review has taken place please do not add
34-
features or make changes out of the scope of those requested by the reviewer
35-
(doing this just add delays as already reviewed code ends up having to be
36-
re-reviewed/it is hard to tell what is new etc!). Further, please do not
37-
rebase your branch on main/force push/rewrite history, doing any of these
38-
causes the context of any comments made by reviewers to be lost. If
39-
conflicts occur against main they should be resolved by merging main
40-
into the branch used for making the pull request.
41-
427
Many thanks in advance for your cooperation!
438
9+
Note: The pull request title will be included in the CHANGELOG.
4410
-->
11+
12+
13+
## Description
14+
<!-- Add brief description here -->
15+
16+
## Issue
17+
<!-- Add closes #ISSUE_NUMBER here, this would close the issue once PR is merged, if there is no issue, please feel free to remove this section -->
18+
19+
## Checklist
20+
21+
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/cuopt/blob/HEAD/CONTRIBUTING.md).
22+
- Testing
23+
- [ ] New or existing tests cover these changes
24+
- [ ] Added tests
25+
- [ ] Created an issue to follow-up
26+
- [ ] NA
27+
- Documentation
28+
- [ ] The documentation is up to date with these changes
29+
- [ ] Added new documentation
30+
- [ ] NA

0 commit comments

Comments
 (0)