diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea83c4eeb1..410b923676 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,3 +9,20 @@ For speedy contributions open it in Gitpod, nu will be pre-installed with the la To get live support from the community see our [Discord](https://discordapp.com/invite/NtAbbGn), [Twitter](https://twitter.com/nu_shell) or file an issue or feature request here on [GitHub](https://github.com/nushell/nushell/issues/new/choose)! +# Developing +## Set up +This is no different than other Rust projects. + +```shell +git clone https://github.com/nushell/nushell +cd nushell +cargo build +``` + +## Tests + +Run tests with: + +```shell +cargo test --all --features=stable,test-bins +``` diff --git a/README.md b/README.md index b7338e02e1..55af7b4ddd 100644 --- a/README.md +++ b/README.md @@ -276,6 +276,10 @@ Nu adheres closely to a set of goals that make up its design philosophy. As feat You can find a list of Nu commands, complete with documentation, in [quick command references](https://www.nushell.sh/documentation.html#quick-command-references). +# Contributing + +See [Contributing](CONTRIBUTING.md) for details. + # License The project is made available under the MIT license. See the `LICENSE` file for more information.