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 #15458: Runtime required components #1707

Open
alice-i-cecile opened this issue Oct 20, 2024 · 2 comments
Open

Write release notes for PR #15458: Runtime required components #1707

alice-i-cecile opened this issue Oct 20, 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#15458 needs release notes for the upcoming Bevy release!

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 /home/alice/Documents/bevy-website/release-content/0.15/release-notes/15458_Runtime_required_components.md and submit a PR.
In that PR, please mention this issue with the Fixes #ISSUE_NUMBER keyphrase so it gets closed automatically.

@Jondolf
Copy link
Contributor

Jondolf commented Oct 20, 2024

I'm guessing we can mention this API in the same section as the core #[require(...)] API and other things related to required components. Cart claimed the Required Components section already, but I can review and write things if needed.

@alice-i-cecile
Copy link
Member Author

Yep, I think that this all gets rolled into the big required components section :)

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