Skip to content

Commit 5a23130

Browse files
committed
chore: update PR checklist
Improve the PR checklist to make it more clear and explicitly ask contributors to run the automated checkstyles. Signed-off-by: Riccardo Mancini <[email protected]>
1 parent 3f51da2 commit 5a23130

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

.github/pull_request_template.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,20 @@ Certificate of Origin and signing off your commits, please check
1515

1616
## PR Checklist
1717

18+
- [ ] I have read and understand [CONTRIBUTING.md][3].
19+
- [ ] I have run `tools/devtool checkstyle` to verify that the PR passes the
20+
automated style checks.
21+
- [ ] I have described what is done in these changes, why they are needed, and
22+
how they are solving the problem in a clear and encompassing way.
23+
- [ ] I have updated any relevant documentation (both in code and in the docs)
24+
in the PR.
25+
- [ ] I have mentioned all user-facing changes in `CHANGELOG.md`.
1826
- [ ] If a specific issue led to this PR, this PR closes the issue.
19-
- [ ] The description of changes is clear and encompassing.
20-
- [ ] Any required documentation changes (code and docs) are included in this
21-
PR.
22-
- [ ] API changes follow the [Runbook for Firecracker API changes][2].
23-
- [ ] User-facing changes are mentioned in `CHANGELOG.md`.
24-
- [ ] All added/changed functionality is tested.
25-
- [ ] New `TODO`s link to an issue.
26-
- [ ] Commits meet
27-
[contribution quality standards](https://github.com/firecracker-microvm/firecracker/blob/main/CONTRIBUTING.md#contribution-quality-standards).
27+
- [ ] When making API changes, I have followed the
28+
[Runbook for Firecracker API changes][2].
29+
- [ ] I have tested all new and changed functionalities in unit tests and/or
30+
integration tests.
31+
- [ ] I have linked an issue to every new `TODO`.
2832

2933
______________________________________________________________________
3034

0 commit comments

Comments
 (0)