open-telemetry / opentelemetry-go-contrib

Collection of extensions for OpenTelemetry-Go.
https://opentelemetry.io/
Apache License 2.0
1.21k stars 565 forks source link

Agree on a naming convention for import declarations for OTEL packages #409

Open matej-g opened 4 years ago

matej-g commented 4 years ago

Throughout the repository, there are generally two forms of import declarations for packages from the main otel repository (e.g. trace, metric, global)

This can be tiresome to work with at times (e.g. in case of comprehensive changes across whole repository) and confusing when introducing new code, as developer cannot be sure which convention to follow.

The suggestion is to agree on one form of import declaration and to uphold it (perhaps via style guide or note in CONTRIBUTING.md).

MrAlias commented 4 years ago

This might be alleviated with upcoming releases that will unify these concepts.