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

What is the deprecation policy and how should breaking changes happen? #77

Open
eriknw opened this issue Mar 31, 2023 · 1 comment
Open

Comments

@eriknw
Copy link
Member

eriknw commented Mar 31, 2023

We should document our policies regarding changes (that aren't strictly additions) to the spec.

We should, of course, try hard to not require changes to be made, but sometimes it's better long term to make backward-incompatible changes.

@mcmillan03
Copy link
Member

Historically:

I always tried to note backward-compatibility breaking changes in the "Revision history" with red text.

In the past we thought that backward-compatibility breaking changes required an increment in the major version number. We may not have realized if we got that wrong until much later (and then were noted in the Revision history).

Regarding deprecation specifically: once we did deprecate a Descriptor enum (renamed it). The old name coexisted with the new name until the next major version increment where the old name was removed from the spec.

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

No branches or pull requests

2 participants