Store migration guides in the repository#867
Merged
Merged
Conversation
Member
Author
|
I also transferred Avian under the new https://github.com/avianphysics organization, so I updated the links to point to that :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
Closes #742.
Until now, we have had the following process:
## Migration GuidesectionWhile this has worked decently well, it has problems:
mainbranch want to see the list of breaking changes before the release is ready. This is especially important at the end of the cycle when people are migrating to a new Bevy version, and we have not made a release yet.We need an evolving up-to-date migration guide that users on
maincan use, and that minimizes friction and late-cycle crunch time.Solution
Move all migration guides into the repository under
migration-guides, in files such as0.3-to-0.4.md. Breaking changes relative to the latest release are stored in e.g.0.4-to-main.mdinstead of PR descriptions. The new process is described inmigration-guides/README.md, which has been adapted from Bevy's version.A core difference to Bevy's approach is that we store the whole guide in one file, instead of splitting it into a number of files based on topic. This is feasible for us, as our guides aren't quite as massive. Additionally, we store all guides in this one repo, as we don't have a separate website where we would display them (yet).
I have also updated our pull request template to match Bevy's. I almost never used the Changelog section in the old one.