Skip to content
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 opened this issue Mar 28, 2022 · 1 comment
Open

Add a way to track breaking changes #1257

ethanwharris opened this issue Mar 28, 2022 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@ethanwharris
Copy link
Collaborator

馃殌 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

@ethanwharris ethanwharris added enhancement New feature or request help wanted Extra attention is needed labels Mar 28, 2022
@ethanwharris ethanwharris added this to the 0.8.0 milestone Mar 28, 2022
@ethanwharris ethanwharris removed the help wanted Extra attention is needed label Mar 28, 2022
@stale
Copy link

stale bot commented Jun 5, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the won't fix This will not be worked on label Jun 5, 2022
@stale stale bot closed this as completed Jun 15, 2022
@ethanwharris ethanwharris removed the won't fix This will not be worked on label Jun 30, 2022
@ethanwharris ethanwharris reopened this Jun 30, 2022
@krshrimali krshrimali removed this from the 0.8.0 milestone Jul 28, 2022
@stale stale bot added the won't fix This will not be worked on label Dec 24, 2022
@Lightning-Universe Lightning-Universe deleted a comment from stale bot Jan 5, 2023
@stale stale bot removed the won't fix This will not be worked on label Jan 5, 2023
@Borda Borda added good first issue Good for newcomers won't fix This will not be worked on labels Jan 5, 2023
@stale stale bot removed the won't fix This will not be worked on label Jan 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants