nushell/CONTRIBUTING.md

Contributing

Welcome to nushell!

Note: for a more complete guide see The nu contributor book

For speedy contributions open it in Gitpod, nu will be pre-installed with the latest build in a VSCode like editor all from your browser.

To get live support from the community see our Discord, Twitter or file an issue or feature request here on GitHub!

Developing

Set up

This is no different than other Rust projects.

git clone https://github.com/nushell/nushell
cd nushell
cargo build

Useful Commands

• Build and run Nushell:

  cargo build --release && cargo run --release
  

• Build and run with extra features:

  cargo build --release --features=extra && cargo run --release --features=extra
  

• Run Clippy on Nushell:

  cargo clippy --all --features=stable
  

• Run all tests:

  cargo test --all --features=stable
  

• Run all tests for a specific command

  cargo test --package nu-cli --test main -- commands::<command_name_here>
  

• Check to see if there are code formatting issues

  cargo fmt --all -- --check
  

• Format the code in the project

  cargo fmt --all
  

Debugging Tips

• To view verbose logs when developing, enable the trace log level.

  cargo build --release --features=extra && cargo run --release --features=extra -- --loglevel trace