mirror of
https://github.com/nushell/nushell
synced 2024-12-26 04:53:09 +00:00
DEV: make all "comments" real md comments in the PR template (#8708)
# 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 ```
This commit is contained in:
parent
8ee52b6ee1
commit
b3d6896977
1 changed files with 8 additions and 8 deletions
16
.github/pull_request_template.md
vendored
16
.github/pull_request_template.md
vendored
|
@ -1,16 +1,16 @@
|
|||
|
||||
# Description
|
||||
<!--
|
||||
Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.
|
||||
|
||||
_(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.)_
|
||||
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.)_
|
||||
<!-- 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:
|
||||
|
@ -26,7 +26,7 @@ Make sure you've run and fixed any issues with these commands:
|
|||
> 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.
|
||||
<!-- 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. -->
|
||||
|
|
Loading…
Reference in a new issue