mirror of https://github.com/nushell/nushell.git synced 2024-10-05 09:52:40 +02: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
```

2023-04-12 12:30:12 -05:00

1.4 KiB Raw Blame History

Description

User-Facing Changes

Tests + Formatting

After Submitting

1.4 KiB

Raw Blame History