Skip to content

Add Experimental CO proposal - #10

Open
acolombier wants to merge 1 commit into
mixxxdj:mainfrom
acolombier:experimental-co
Open

Add Experimental CO proposal#10
acolombier wants to merge 1 commit into
mixxxdj:mainfrom
acolombier:experimental-co

Conversation

@acolombier

Copy link
Copy Markdown
Member

No description provided.

Comment on lines +60 to +62
### Experimental marker

The suggested experimental marker is the prefix `x_`, e.g., `x_beats_set_change_marker`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants