diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 200ac7d3..e5f8cdfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,7 +58,7 @@ Any community member can review a PR. #### Commit Squashing -There is no need to squash your commits manually. PRs are usually squash merged anyway. +There is no need to squash your commits manually. ### CI @@ -70,7 +70,7 @@ Please ensure that your PR passes the CI checks: - [Rustdoc](https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html) links work -If you are on a *nix system, you can use the [`scripts/ci-check.sh`](scripts/ci-check.sh) script to quickly check if you pass the CI checks. +The [`ci-check.sh`](ci-check.sh) can help with this. #### Add an entry to the changelog diff --git a/scripts/ci-check.sh b/ci-check.sh similarity index 71% rename from scripts/ci-check.sh rename to ci-check.sh index 4fed8853..de95e43a 100755 --- a/scripts/ci-check.sh +++ b/ci-check.sh @@ -3,25 +3,27 @@ set -e MSRV="1.74.0" -echo "fmt check" +echo "MSRV set to $MSRV" + +echo "cargo fmt" cargo fmt --all --check echo "clippy" cargo clippy -q --all-features --all-targets --workspace -- -D warnings -echo "build docs" +echo "Building docs" RUSTDOCFLAGS="--cfg docsrs -D warnings" cargo doc -q --no-deps --all-features --document-private-items -echo "build tests" +echo "Building tests" cargo test -q --no-run -echo "running tests..." +echo "Running tests..." cargo test -q > /dev/null -echo "build tests on msrv" +echo "Building tests on MSRV" RUSTUP_TOOLCHAIN="$MSRV" cargo test -q --no-run -echo "running tests on msrv..." +echo "Running tests on MSRV..." RUSTUP_TOOLCHAIN="$MSRV" cargo test -q > /dev/null echo ">>>>>> ALL OK <<<<<<<<"