Skip to content
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.

Add a way to track breaking changes #1257

Open
@ethanwharris

Description

🚀 Feature

We should have a way to track breaking changes (maybe something like the CHANGELOG) so that each release we can have the list of breaking changes in the release notes.

Motivation

Difficult for users to know when a breaking change is introduced

Pitch

A document (BREAKING_CHANGES.md) which lists for each major version the breaking changes:

  • for removal of a deprecated feature
  • for breaking changes without warning in beta features

Alternatives

Just manually collect this with each release

cc @krshrimali

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions