diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bf2b4d6f..c2d9ba3ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,7 +54,12 @@ cargo test -p fj-kernel You can run the full suite of checks and tests like this: ``` sh -just build +just ci +``` + +You can also run a lighter version that just checks for code correctness: +``` sh +just test ``` This requires [`just`](https://crates.io/crates/just), which you can install like this: diff --git a/justfile b/justfile index 4816831ce..7b0f2fb0f 100644 --- a/justfile +++ b/justfile @@ -1,9 +1,24 @@ export RUSTDOCFLAGS := "-D warnings" -build: +# Run all tests, including end-to-end export validation tests. +# +# This command is designed to be used regularly during CAD kernel development. +# It runs tests to check for code correctness, but accepts warnings in the code +# and does not check formatting or documentation. +# +# For a full build that mirrors the CI build, see `just ci`. +test: + cargo test --all-features + cargo run --package export-validator + +# Run a full build that mirrors the CI build +# +# Basically, if this passes locally, then the CI build should pass too, once you +# submit your work as a pull request. Please note that the CI build is +# maintained separately from this file. Most deviations in behavior should +# probably be considered a bug in this file. +ci: test cargo fmt --check cargo clippy --all-features -- -D warnings - cargo test --all-features cargo doc --no-deps --document-private-items --all-features --workspace cargo run --package cross-compiler - cargo run --package export-validator