Skip to content

Commit 44cb0ad

Browse files
authored
Update PULL_REQUEST_TEMPLATE.md
1 parent c37b890 commit 44cb0ad

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

Diff for: system/PULL_REQUEST_TEMPLATE.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1-
### Pull Request check-list
1+
<!--
2+
Thank you for your pull request. Please provide a description above and review
3+
the requirements below.
24
3-
_Please make sure to review and check all of these items:_
5+
Bug fixes and new features should include tests and possibly benchmarks.
46
5-
- [ ] Does UNIX or Windows pass with
6-
this change (including linting)?
7-
- [ ] Is the commit message formatted according to CONTRIBUTING.md?
8-
- [ ] If this change fixes a bug (or a performance problem), is a regression
9-
test (or a benchmark) included?
10-
- [ ] Is a documentation update included (if this change modifies
11-
existing APIs, or introduces new ones)?
7+
Contributors guide: ./CONTRIBUTING.md
8+
-->
129

13-
_NOTE: these things are not required to open a PR and can be done
14-
afterwards / while the PR is open._
10+
<!-- _Please make sure to review and check all of these items:_ -->
11+
12+
13+
##### Checklist
14+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
15+
16+
- [ ] `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes
17+
- [ ] tests and/or benchmarks are included
18+
- [ ] documentation is changed or added
19+
- [ ] commit message follows [commit guidelines](./doc/guides/contributing/pull-requests.md#commit-message-guidelines)
20+
21+
<!-- _NOTE: these things are not required to open a PR and can be done afterwards / while the PR is open._ -->
1522

1623
### Affected core subsystem(s)
1724
<!-- Please provide affected core subsystem(s). -->

0 commit comments

Comments
 (0)