|
| 1 | +# Bevy's Migration Guide Process |
| 2 | + |
| 3 | +Hi! Did someone add `M-Needs-Migration-Guide` to your PR? If so, you're in the right place. |
| 4 | +Let's talk about how this process works. |
| 5 | + |
| 6 | +When we make breaking changes to Bevy, we need to communicate them to users so their libraries and applications can be moved to the new Bevy version. |
| 7 | +To do this, we write and ship a [migration guide](https://bevyengine.org/learn/migration-guides/introduction/) for every major Bevy version. |
| 8 | +To avoid a crunch at the end of the cycle as we *write* all of these, |
| 9 | +Bevy asks authors (and reviewers) to write a draft migration guide as part of the pull requests that make breaking changes. |
| 10 | + |
| 11 | +## Where to put your migration guides |
| 12 | + |
| 13 | +Each major Bevy version (e.g. 0.12, or 2.0) will get its own migration guide. |
| 14 | +The draft migration guides are organized into a folder of the same name inside of `bevyengine/bevy/working-migration-guides`. |
| 15 | + |
| 16 | +When we publish our first release candidate for a cycle, these notes are moved from `bevyengine/bevy`, and into `bevyengine/bevy-website`, |
| 17 | +where they will receive a final editing pass. |
| 18 | + |
| 19 | +## What to put in your draft migration guide |
| 20 | + |
| 21 | +A `template.md` file is provided in `bevyengine/bevy/working-migration-guides`: copy-paste that to get started! |
| 22 | + |
| 23 | +Migration guides are intended to briefly communicate: |
| 24 | + |
| 25 | +- what has been changed since the last release? |
| 26 | +- why did we make this breaking change? |
| 27 | +- how can users migrate their existing code? |
| 28 | + |
| 29 | +Draft migration guides *do not need to be polished*: it's okay if you're not a native English speaker or aren't a wordsmith. |
| 30 | +Editing is easy; we just want to have an expert's view on the questions above. |
| 31 | + |
| 32 | +When writing migration guides, prefer terse, technical language, and be sure to include terms that users might search for. |
| 33 | +Migration guides are not read end-to-end: instead, they are navigated via Ctrl+F as the reader follows the compiler errors and bugs. |
| 34 | + |
| 35 | +## Grouping changes into migration guides |
| 36 | + |
| 37 | +Migration guides should reflect the complete experience of migrating from the last major Bevy version to the next one. |
| 38 | +If there are *multiple* breaking changes layered on top of each other, |
| 39 | +you should edit the existing migration guide, rather than write a new one. |
| 40 | + |
| 41 | +While some brave users live on Bevy's `main` branch, we can trust them to use the draft migration guides and read the PRs in question if needed. |
| 42 | + |
| 43 | +As a result, each draft migration should be given a clear name matching the section title. |
| 44 | +These titles should reflect the name of the old feature that was broken or changed. |
| 45 | + |
| 46 | +## Note on the `#[deprecated]` attribute |
| 47 | + |
| 48 | +Rust provides a very helpful [`#[deprecated]` attribute](https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute), which is a compiler-aware way to mark a piece of Rust code as obsolete and slated for removal. |
| 49 | +This can be a nice a tool to ease migrations, because it downgrades errors to warnings and makes the migration information available right in the user's IDE. |
| 50 | + |
| 51 | +However, it's not always possible to use this attribute, and Bevy does not consider it to be a substitute to a migration guide entry. |
0 commit comments