From e27ba8c47ddd96892bc69c51e958a60abdee45e8 Mon Sep 17 00:00:00 2001 From: mkayaalp Date: Sun, 14 Nov 2021 21:45:58 -0500 Subject: [PATCH] docs: Remove references to `just` (removed by #2923) --- CONTRIBUTING.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f56e42daf3..424ed7bad38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,45 +6,27 @@ Another really great way to help is if you find an interesting, or helpful way i ### Testing Code -To test with all features both enabled and disabled, you can run these commands: +To test with all features both enabled and disabled, you can run this command: ```sh $ cargo test --features "wrap_help yaml regex unstable-replace" ``` -Alternatively, if you have [`just`](https://github.com/casey/just) installed you can run the prebuilt recipes. *Not* using `just` is perfectly fine as well, it simply bundles commands automatically. - -For example, to test the code, as above simply run: - -```sh -$ just run-tests -``` - -From here on, I will list the appropriate `cargo` command as well as the `just` command. - Sometimes it's helpful to only run a subset of the tests, which can be done via: ```sh $ cargo test --test - -# Or - -$ just run-test ``` ### Linting Code During the CI process `clap` runs against many different lints using [`clippy`](https://github.com/rust-lang/rust-clippy). -In order to check the code for lints and to format it run either: +In order to check the code for lints and to format it run: ```sh $ cargo clippy --features "wrap_help yaml regex unstable-replace" -- -D warnings $ cargo fmt -- --check - -# Or - -$ just lint ``` ### Debugging Code @@ -56,9 +38,6 @@ $ cargo test --features debug # Or for individual tests $ cargo test --test --features debug - -# The corresponding just command for individual debugging tests is: -$ just debug ``` ### Tests and Documentation