mirror of
https://github.com/nushell/nushell.git
synced 2025-02-08 22:51:42 +01:00
b3d6896977
# Description i sometimes see some sections of the PR template being left untouched by contributors 🤔 this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands 🤔 > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates 😕 # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
33 lines
1.4 KiB
Markdown
33 lines
1.4 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
|
|
- `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library
|
|
|
|
> **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. -->
|