Add Experimental CO proposal #10
Open
Conversation
This file contains 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
Swiftb0y
reviewed
Nov 19, 2024
Comment on lines
+60
to
+62
| ### Experimental marker | ||
|
|
||
| The suggested experimental marker is the prefix `x_`, e.g., `x_beats_set_change_marker`. |
There was a problem hiding this comment.
I'm unsure whether this experimental marker should be naming related. An explicit opt-in may be better (add a flag for creating the CO and only make it accessible if the consumer explicitly opts in). That would require some slight API changes though...
Comment on lines
+55
to
+58
| experimentation sandbox. During the version following the CO stable promotion, an alias should be kept to its former | ||
| key to prevent breaking changes. The Mixxx Core Team may decide to extend the alias period by a second version cycle | ||
| but should refrain from doing it more than once in order to reduce the amount of COs that have an impact on | ||
| performance. |
There was a problem hiding this comment.
I'd drop that IMO. These experimental COs are strictly for experimentation. Promising any sort of stability guarantees makes it too easy to get distracted from that experimentation by trying to uphold those guarantees. An experimental CO should only be used by in-tree code, that way removing code relying on it is as easy as grepping for it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.