diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81b460810b..26b60d66b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,10 +19,40 @@ cd nushell cargo build ``` -## Tests +## Useful Commands -Run tests with: +Build and run Nushell: + +```shell +cargo build --release && cargo run --release +``` + +Run Clippy on Nushell: + +```shell +cargo clippy --all --features=stable +``` + +Run all tests: ```shell cargo test --all --features=stable ``` + +Run all tests for a specific command + +```shell +cargo test --package nu-cli --test main -- commands:: +``` + +Check to see if there are code formatting issues + +```shell +cargo fmt --all -- --check +``` + +Format the code in the project + +```shell +cargo fmt --all +```