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

Write release notes for PR #12013: Upstreaming bevy_color. #1228

Closed
alice-i-cecile opened this issue May 30, 2024 · 2 comments
Closed

Write release notes for PR #12013: Upstreaming bevy_color. #1228

alice-i-cecile opened this issue May 30, 2024 · 2 comments
Labels
A-Release-Notes C-Content S-Ready-For-Implementation The core questions are answered: just add code
Milestone

Comments

@alice-i-cecile
Copy link
Member

bevyengine/bevy#12013 needs release notes for the upcoming Bevy release!

Original authors: @viridia, @mockersf

Please reply below if you'd like to write these notes.
While the author(s) of the PR often have the context, knowledge and motivation to draft the release notes for their feature,
anyone can contribute release notes!


Release notes should:

  1. Clearly motivate the change.
  2. Be written in a way that is understandable by the average Bevy user: some programming background and a general understanding of games.
  3. Show off the coolest features of the PR. Screenshots are awesome, but elegant APIs are also welcome!
  4. If this was a perf-centric PR, quantify the performance improvements. Graphs and statistics work well for this.

We can help you revise the release notes: a rough draft alone is incredibly useful :)
Your expertise is invaluable for contextualizing the changes; we'll work with you to bring the technical writing up to par.

To submit your release notes, modify ..\release-content\0.14\release-notes\12013_Upstreaming_bevy_color.md and submit a PR.
In that PR, please mention this issue with the Fixes #ISSUE_NUMBER keyphrase so it gets closed automatically.

@alice-i-cecile alice-i-cecile added A-Release-Notes C-Content S-Ready-For-Implementation The core questions are answered: just add code labels May 30, 2024
@alice-i-cecile alice-i-cecile added this to the Release v0.14 milestone May 30, 2024
@viridia
Copy link

viridia commented May 30, 2024

This has already been done, you can close this.

Generating a ticket for each individual PR is going to be problematic in cases like bevy_color, where a single "feature" is the result of a large number of individual PRs. In the resulting release notes there's only going to be a single bevy_color "section" which aggregates all of the individual contributions.

@alice-i-cecile
Copy link
Member Author

Generating a ticket for each individual PR is going to be problematic in cases like bevy_color, where a single "feature" is the result of a large number of individual PRs. In the resulting release notes there's only going to be a single bevy_color "section" which aggregates all of the individual contributions.

Yep, the plan going forward is to aggregate the PRs by marking only one for each group of features with C-Needs-Release-Note, and then finalizing that before generating issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Release-Notes C-Content S-Ready-For-Implementation The core questions are answered: just add code
Projects
None yet
Development

No branches or pull requests

2 participants