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

Use singular form for directory names #810

Closed
rhcarvalho opened this issue Jun 2, 2021 · 2 comments
Closed

Use singular form for directory names #810

rhcarvalho opened this issue Jun 2, 2021 · 2 comments

Comments

@rhcarvalho
Copy link

It is common practice in Go to name package path components in singular, so

  • exporter/metric/...
  • propagator
  • detector
  • instrumentation (currently already in singular form)

Right now of the 4 areas of this repo, one is already in singular form and the other 3 are plural.

Other Go repos in OpenTelemetry do follow the practice of using singular, for example the Collector and Collector-Contrib.

Opening this issue to discuss renaming exporters/, propagators/ and detectors/ to the singular form before GA.

@MrAlias
Copy link
Contributor

MrAlias commented Jun 8, 2021

Changing these names needs to be done with a lot of caution. It will change the module/package names meaning there will be discoverability issues in the future when users find the old deadend modules/packages and think they are the current ones.

There are examples of plurals in other Go projects including the standard library: bytes, errors, strings. We should be sure we are making the change for an agreed upon reason instead of a preference here.

@MrAlias
Copy link
Contributor

MrAlias commented Nov 2, 2022

Thanks for the suggestion. At this point the stability of the packages this provides outweighs the desire to use more common singular names in the package. Closing.

@MrAlias MrAlias closed this as completed Nov 2, 2022
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

No branches or pull requests

2 participants