Skip to content

Commit 213a6d2

Browse files
Manciukicroypat
authored andcommitted
doc: add instructions to run checkbuild before PR
We will ask contributors to check the PR builds correctly on all architectures before submitting the review. Signed-off-by: Riccardo Mancini <[email protected]>
1 parent 2c56cbb commit 213a6d2

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Certificate of Origin and signing off your commits, please check
1616
## PR Checklist
1717

1818
- [ ] I have read and understand [CONTRIBUTING.md][3].
19+
- [ ] I have run `tools/devtool checkbuild --all` to verify that the PR passes
20+
build checks on all supported architectures.
1921
- [ ] I have run `tools/devtool checkstyle` to verify that the PR passes the
2022
automated style checks.
2123
- [ ] I have described what is done in these changes, why they are needed, and

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,16 @@ following in the Firecracker root directory:
6363
```
6464
cat >> .git/hooks/pre-commit << EOF
6565
./tools/devtool checkstyle || exit 1
66+
./tools/devtool checkbuild --all || exit 1
6667
EOF
6768
```
6869

69-
This will automatically lint your Rust, markdown and python changes when running
70-
`git commit`, as well as running any other checks our CI validates as part of
71-
its 'Style' step. Most reported violations can be automatically fixed using
72-
`./tools/devtool fmt`.
70+
The first command will automatically lint your Rust, markdown and python changes
71+
when running `git commit`, as well as running any other checks our CI validates
72+
as part of its 'Style' step. Most reported violations can be automatically fixed
73+
using `./tools/devtool fmt`. The second command will then check that the code
74+
correctly compiles on all supported architectures, and that it passes Rust
75+
clippy rules defined for the project.
7376

7477
Your contribution needs to meet the following standards:
7578

0 commit comments

Comments
 (0)