bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
193 stars 336 forks source link

Write release notes for PR #15276: Reduce runtime panics through `SystemParam` validation #1691

Open alice-i-cecile opened 1 day ago

alice-i-cecile commented 1 day ago

https://github.com/bevyengine/bevy/pull/15276 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/15276_Reduce_runtime_panics_through_SystemParam_validation.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 commented 1 day ago

This should be lumped into the Single / Populated release notes @MiniaczQ.

MiniaczQ commented 1 day ago

Yeah, I was gonna ask about that when I got to it, should I put all 3 of notes into single PR's file?

alice-i-cecile commented 1 day ago

Yes please. Use the fancy new PR merging tech that was added in #1650.