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

New features deserve migration guides #1888

Open
IQuick143 opened this issue Nov 30, 2024 · 1 comment
Open

New features deserve migration guides #1888

IQuick143 opened this issue Nov 30, 2024 · 1 comment

Comments

@IQuick143
Copy link
Contributor

Problem

Adding new features sometimes gates previously accessible types or functionality, this is a breaking change that should be documented in migration guides.

This is especially problematic when the new feature is a part of default features, meaning that it's much less likely to get caught as a breaking change (because it does not break projects who enable default features, only projects who specify their features manually).

Example

When migrating to 0.15.0, my project failed to compile because of a missing Window type, which requires the new bevy_window feature.

Solution

PRs that introduce new features should be mentioned in the migration guides, possibly even getting sections.
(Though it might be enough to have a single section that documents that new features have been added and that it might be necessary to evaluate them for your project.)

@rparrett
Copy link
Contributor

This is related to #1872

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants