forked from extern/nushell
7e82f8d9b5
i was writing #8148 and came to the "_Test + Formatting_" section of the PR template. i felt the developer instructions could be wrapped up in a common easy to use format, e.g. a `Makefile`, to be used with a few-words command only, e.g. `make fmt` or `make clippy`, instead of the long commands in the PR template 🤔 > **Note** > in case you guys do not want to add a `Makefile` to the `nushell` source, that PR can be discarded 😌 # Description this PR - adds the few rules from the PR template to a new `Makefile` - replaces the instructions in the PR template from the full commands to the new `make` rules # User-Facing Changes - _none for the regular user_ - i believe easier to test PRs for the developer, allowing one not to realy on knowing the long commands or using the shell history to run them again 😋 # Tests + Formatting _nothing to test_ # After Submitting maybe mention that in `CONTRIBUTING.md`?
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
|
|
# Description
|
|
|
|
_(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_
|
|
|
|
_(Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.)_
|
|
|
|
# User-Facing Changes
|
|
|
|
_(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_
|
|
|
|
# Tests + Formatting
|
|
|
|
Don't forget to add tests that cover your changes.
|
|
|
|
Make sure you've run and fixed any issues with these commands:
|
|
|
|
- `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes)
|
|
- `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
|
|
|
|
> **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
|
|
> ```
|
|
|
|
# After Submitting
|
|
|
|
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.
|