nushell/nu_scripts
1
1
Fork 0
mirror of https://github.com/nushell/nu_scripts.git synced 2024-08-17 01:10:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

enhance release note PR template (#618)

Browse Source 
in this PR i propose
- to add a note about the use of a "breaking change" banner when
detailing a breaking change in it's own section
👉 see the [*Pythonesque operators removal* section of
0.85](https://www.nushell.sh/blog/2023-09-19-nushell_0_85_0.html#pythonesque-operators-removal)
- because we have had these sections for a few releases now, add "hall
of fame" and "changed to commands" sections
This commit is contained in:
Antoine Stevan 2023-10-14 09:39:24 +02:00 committed by GitHub
parent 85da8c2fb5
commit a68382130c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
make_release/release-note/template.md
View File

@ -23,11 +23,29 @@ NOTE: The optional dataframe functionality is available by `cargo install nu --f
As part of this release, we also publish a set of optional plugins you can install and use with Nu. To install, use `cargo install nu_plugin_<plugin name>`.
# Themes of this release / New features
<!-- NOTE: if you wanna write a section about a breaking change, when it's a very important one,
please add the following snippet to have a "warning" banner :)
> see [an example](https://www.nushell.sh/blog/2023-09-19-nushell_0_85_0.html#pythonesque-operators-removal)
## New theme ([author](https://github.com/nushell/nushell/pulls))
```md
::: warning Breaking change
See a full overview of the [breaking changes](#breaking-changes)
:::
```
-->
## Hall of fame
### Bug fixes
### Enhancing the documentation
## Our set of commands is evolving
### New commands
### Changes to existing commands
### Deprecated commands
### Removed commands
# Breaking changes
<!-- TODO
<!-- TODO:
paste the output of
```nu
./make_release/release-note/list-merged-prs nushell/nushell --label breaking-change --pretty --no-author
@ -36,7 +54,7 @@ As part of this release, we also publish a set of optional plugins you can insta
-->
# Full changelog
<!-- TODO
<!-- TODO:
paste the output of
```nu
./make_release/release-note/get-full-changelog