2022-11-14 23:43:15 +00:00
2022-01-24 19:01:03 +00:00
# Description
2022-11-14 23:43:15 +00:00
_(Thank you for improving Nushell. Please, check our [contributing guide ](../CONTRIBUTING.md ) and talk to the core team before making major changes.)_
2022-11-07 21:57:29 +00:00
2022-11-14 23:43:15 +00:00
_(Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.)_
2022-11-07 21:57:29 +00:00
2022-11-14 23:43:15 +00:00
# User-Facing Changes
2022-02-21 13:38:15 +00:00
2022-11-14 23:43:15 +00:00
_(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_
2022-01-24 18:58:09 +00:00
2022-11-14 23:43:15 +00:00
# Tests + Formatting
2022-06-16 13:14:59 +00:00
2022-11-14 23:43:15 +00:00
Don't forget to add tests that cover your changes.
2022-06-16 13:14:59 +00:00
2022-01-24 18:58:09 +00:00
Make sure you've run and fixed any issues with these commands:
2022-10-28 16:14:08 +00:00
- `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes)
2022-11-23 00:58:11 +00:00
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass
2023-04-07 20:12:27 +00:00
- `cargo run -- crates/nu-std/tests.nu` to run the tests for the standard library
2022-10-16 15:19:54 +00:00
2023-03-11 18:10:32 +00:00
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it automatically
> toolkit check pr
> ```
2022-11-07 21:57:29 +00:00
# After Submitting
2022-10-28 16:14:08 +00:00
2022-11-14 23:43:15 +00:00
If your PR had any user-facing changes, update [the documentation ](https://github.com/nushell/nushell.github.io ) after the PR is merged, if necessary. This will help us keep the docs up to date.
