Allow overlapping compat keys#4034
Open
ddbeck wants to merge 1 commit into
Open
Conversation
ddbeck
added
the
minor version required
github-actions
Bot
added
documentation
ddbeck
force-pushed
the
overlap-compat-keys
branch
4 times, most recently
from
25832e1 to
55e55d1
Compare
ddbeck
force-pushed
the
overlap-compat-keys
branch
from
55e55d1 to
e473578
Compare
foolip
reviewed
May 26, 2026
| You can add a single key to two or more `compat_features` lists when independent features share some interface and one of these situations applies: | ||
|
|
||
| - No feature has any claim to being first and the shared interface does not represent a useful feature on its own. | ||
| This sometimes happens when two independent features share a common interface. |
Collaborator
There was a problem hiding this comment.
I think such features are very rarely independent, and more commonly are closely related:
Suggested change
| This sometimes happens when two independent features share a common interface. | |
| This sometimes happens when two features share a common interface. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Towards #1173 and a prerequisite to feature merging.
This PR allows authors to allow BCD keys to be shared between features, by adding them to an allow list. It provides guidelines for when to do this (rarely) and demonstrates it by resolving one of the commented cases where we wished to do this.
This PR is not strictly breaking, but we should announce it in the upcoming changes discussion thread and emphasize this change in the release notes.