Skip to content

New features deserve migration guides #1888

@IQuick143

Description

@IQuick143

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.)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions