Skip to content

Commit 42d41db

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 42d41db

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

.github/pull_request_template.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,21 @@ Certificate of Origin and signing off your commits, please check
1515

1616
## PR Checklist
1717

18-
- [ ] 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
18+
- [ ] I have read and understand the
2719
[contribution quality standards](https://github.com/firecracker-microvm/firecracker/blob/main/CONTRIBUTING.md#contribution-quality-standards).
20+
- [ ] I have run `tools/devtool checkstyle` to verify that the PR passes the
21+
automated style checks.
22+
- [ ] I have described what is done in these changes, why they are needed, and
23+
how they are solving the problem in a clear and encompassing way.
24+
- [ ] I have updated any relevant documentation (both in code and in the docs)
25+
in the PR.
26+
- [ ] I have mentioned all user-facing changes in `CHANGELOG.md`.
27+
- [ ] If a specific issue led to this PR, this PR closes the issue.
28+
- [ ] When making API changes, I have followed the
29+
[Runbook for Firecracker API changes][2].
30+
- [ ] I have tested all new and changed functionalities in unit tests and/or
31+
integration tests.
32+
- [ ] I have linked an issue to every new `TODO`.
2833

2934
______________________________________________________________________
3035

0 commit comments

Comments
 (0)