Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve release notes tracking issue #1838

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

Urgau
Copy link
Member

@Urgau Urgau commented Sep 6, 2024

This PR improves the release notes tracking issue template by mainly

  • adding headers to better distinguish the sections
  • putting the choose category under the GitHub TIP section
  • rewording the choose category text to simplify it
  • making the main text on one line (instead of splitting it)

r? @Mark-Simulacrum

@Urgau
Copy link
Member Author

Urgau commented Sep 6, 2024

Example of the modified template. (un-modified)


This issue tracks the release notes text for #126158.

Steps

  • Proposed text is drafted by PR author (or team) making the noteworthy change.
  • Issue is nominated for release team review of clarity for wider audience.
  • Release team includes text in release notes/blog posts.

Release notes text

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).

# Category (e.g. Language, Compiler, Libraries, Compatibility notes, ...)
- [Disallow setting some built-in cfg via the command-line](https://github.com/rust-lang/rust/pull/126158)

Tip

Use the previous releases categories to help choose which one(s) to use.
The category will be de-duplicated with all the other ones by the release team.

More than one section can be included if needed.

Release blog section

If the change is notable enough for inclusion in the blog post, the responsible team should add content to this section.
Otherwise leave it empty.

cc {} -- origin issue/PR authors and assignees for starting to draft text

@Urgau Urgau force-pushed the relnotes-improvements branch from 1c2ffc5 to e6c32f4 Compare September 6, 2024 22:25
@Mark-Simulacrum Mark-Simulacrum merged commit 801fe08 into rust-lang:master Sep 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants