Skip to content

Commit 1c2ffc5

Browse files
committed
Improve release notes tracking issue
1 parent c35ff9f commit 1c2ffc5

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

src/handlers/relnotes.rs

+14-10
Original file line numberDiff line numberDiff line change
@@ -75,27 +75,31 @@ pub async fn handle(ctx: &Context, event: &Event) -> anyhow::Result<()> {
7575
"
7676
This issue tracks the release notes text for #{}.
7777
78+
### Steps
79+
7880
- [ ] Proposed text is drafted by PR author (or team) making the noteworthy change.
7981
- [ ] Issue is nominated for release team review of clarity for wider audience.
8082
- [ ] Release team includes text in release notes/blog posts.
8183
82-
Release notes text:
84+
### Release notes text
8385
84-
The responsible team for the underlying change should edit this section to replace the
85-
automatically generated link with a succinct description of what changed, drawing upon text
86-
proposed by the author (either in discussion or through direct editing). If the change is notable
87-
enough for inclusion in the blog post, add content to the blog section below.
86+
The responsible team for the underlying change should edit this section to replace the automatically generated link with a succinct description of what changed, drawing upon text proposed by the author (either in discussion or through direct editing).
8887
8988
```markdown
90-
# Pick a category...
89+
# Category (e.g. Rust, Library, Compatibility notes, ...)
9190
- [{}]({})
9291
```
9392
94-
Note: The section title will be de-duplicated by the release team with other release notes issues.
95-
Please use a standard title from [previous releases](https://doc.rust-lang.org/nightly/releases.html).
96-
More than one section can be included if needed.
93+
> [!TIP]
94+
> Use the [previous releases](https://doc.rust-lang.org/nightly/releases.html) categories to help choose which one(s) to use.
95+
> The category will be de-duplicated with all the other ones by the release team.
96+
>
97+
> *More than one section can be included if needed.*
98+
99+
### Release blog section
97100
98-
Release blog section (if any, leave blank if no section is expected):
101+
If the change is notable enough for inclusion in the blog post, the responsible team should add content to this section.
102+
*Otherwise leave it empty.*
99103
100104
```markdown
101105
```

0 commit comments

Comments
 (0)