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

Proposal: Naming for features #1411

Open
hdost opened this issue Nov 29, 2023 · 1 comment
Open

Proposal: Naming for features #1411

hdost opened this issue Nov 29, 2023 · 1 comment
Labels
A-common Area:common issues that not related to specific pillar release:required-for-stable Must be resolved before GA release, or nice to have before GA.

Comments

@hdost
Copy link
Contributor

hdost commented Nov 29, 2023

After our discussions in the SIG yesterday and some prior conversations we should probably get some sort of alignement of feature naming.

The most recent example here:

maybe we should develop some convention saying, all experimental features must begin with "experimental-feature"?

Originally posted by @cijothomas in #1410 (comment)

I think some goals would be:

  • Clarity of purpose - What aspect is it changing?
  • Clarity of status - Is this an experiment or stable feature ?
  • Simplicity - this is a bit harder to define, but let's try to be less wordy when possible.
  • Minimal Defaults - default should contain core features or very few features

We know we should be using kebab-case. However we have a couple different dimensions to consider.

  1. Is the specification for the feature experimental or stable?
  2. Is the feature an unstable implementation of a stable spec?
  3. Is the feature just an otherwise optional feature?

I know that @TommyCpp had mentioned just documenting things. Does that mean just putting in our documentation that a feature is experimental?
Someone else mentioned default being the marker for stable or not.

If we look to the rust compiler there's a concept of a nightly compiler which you can use and once you're using that you can enable features which are unstable but I think this may not map 100%.

Personally I see a couple ways, but I'd rather hear first from the rest of the group.

References:

@hdost hdost added A-common Area:common issues that not related to specific pillar release:required-for-stable Must be resolved before GA release, or nice to have before GA. labels Nov 29, 2023
@hdost hdost added this to the Tracing API Stable milestone Nov 29, 2023
@hdost
Copy link
Contributor Author

hdost commented Dec 1, 2023

#1410 (comment)
Apparently this conversation happened all in this PR
@open-telemetry/rust-approvers for discoverability

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-common Area:common issues that not related to specific pillar release:required-for-stable Must be resolved before GA release, or nice to have before GA.
Projects
None yet
Development

No branches or pull requests

1 participant