Skip to content

Commit 5a2b4e9

Browse files
authored
docs: refresh our PR template (#23)
Signed-off-by: Terry Kong <terryk@nvidia.com>
1 parent a5ec198 commit 5a2b4e9

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
# What does this PR do ?
22

3-
Add a one line overview of what this PR aims to accomplish.
3+
**Add a one line overview of what this PR aims to accomplish.**
4+
5+
# Issues
6+
List issues that this PR closes ([syntax](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)):
47

5-
# Changelog
6-
- Please update the [CHANGELOG.md](/CHANGELOG.md) under next version with high level changes in this PR.
78

89
# Usage
9-
* You can potentially add a usage example below
10+
* **You can potentially add a usage example below**
1011

1112
```python
1213
# Add a code snippet demonstrating how to use this
1314
```
1415

1516
# Before your PR is "Ready for review"
1617
**Pre checks**:
17-
- [ ] Make sure you read and followed [Contributor guidelines](/CONTRIBUTING.md)
18+
- [ ] Make sure you read and followed [Contributor guidelines](/NVIDIA/reinforcer/blob/main/CONTRIBUTING.md)
1819
- [ ] Did you write any new necessary tests?
19-
- [ ] Did you add or update any necessary documentation? Make sure to also update the [NeMo Framework User Guide](https://docs.nvidia.com/nemo-framework/user-guide/latest/index.html) which contains the tutorials
20-
21-
# Checklist when contributing
22-
- [ ] TBD
20+
- [ ] Did you run the unit tests and functional tests locally? Visit our [Testing Guide](/NVIDIA/reinforcer/blob/main/docs/testing.md) for how to run tests
21+
- [ ] Did you add or update any necessary documentation? Visit our [Document Development Guide](/NVIDIA/reinforcer/blob/main/docs/documentation.md) for how to write, build and test the docs.
2322

2423
# Additional Information
25-
* Related to # (issue)
24+
* ...

0 commit comments

Comments
 (0)