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.

Sign up for GitHub

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

document compatibility flag policy #2843

Open
wants to merge 1 commit into
base: release-7.x
Choose a base branch
from
Open

document compatibility flag policy #2843

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/compatibilityFlags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### Compatibility Flags

Any semantic breaking change (those changes which do not break source or binary compatibility, but change the behavior in such a way that callers will receive unexpected results) should be added behind a compatibility flag.
The flag should allow callers to opt in to the new behavior and should be marked `Obsolete`.

At the next major release, the behavior should be changed so that the default behavior acts as though the flag were enabled.
The flag should be removed and replace with a new flag that allows callers to opt out of the new behavior.
The new flag should be marked `Obsolete`.

At the subsequent major release, the old behavior should be removed along with the flag.
Loading