dsg/cloud-hypervisor
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: adjust contributing.md: remove need for --all (--workspace)

Browse source 
It is no longer needed to add `--all` (which is an alias for
`--workspace`). The documentation says "Commands run in the workspace
root will run against all workspace members by default" [0].

We however still need `--tests` as this activates the building of
tests in `<crate>/tests` directories.

[0] https://doc.rust-lang.org/cargo/reference/workspaces.html#virtual-workspace

Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de>
On-behalf-of: SAP philipp.schuster@sap.com
This commit is contained in:
Philipp Schuster 2025-12-04 13:54:09 +01:00 • committed by Rob Bradford
parent 9979e562b2
commit 3191ff26e1
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -22,10 +22,10 @@ convention and enforce it through the Continuous Integration (CI) process callin
```sh
# We currently rely on nightly-only formatting features
cargo +nightly fmt --all
cargo check --all --all-targets --tests
cargo clippy --all --all-targets --tests
cargo check --all-targets --tests
cargo clippy --all-targets --tests
# Please note that this will not execute integration tests.
cargo test --all --all-targets --tests
cargo test --all-targets --tests
# To lint your last three commits
gitlint --commits "HEAD~3..HEAD"
@ -49,8 +49,8 @@ have specific features that you regularly develop against.
#!/bin/sh
cargo +nightly fmt --all -- --check || exit 1
cargo check --locked --all --all-targets --tests || exit 1
cargo clippy --locked --all --all-targets --tests -- -D warnings || exit 1
cargo check --locked --all-targets --tests || exit 1
cargo clippy --locked --all-targets --tests -- -D warnings || exit 1
```
You will need to `chmod +x .git/hooks/pre-commit` to have it run on every