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

Explain stability guarantees for experimental packages #177

Merged
merged 2 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ Generated Go code for the OpenTelemetry protobuf data model.

## Versioning Policy

The autogenerated Go code follows the stability guarantees as defined in
The auto-generated Go code follows the stability guarantees as defined in
[maturity
level](https://github.com/open-telemetry/opentelemetry-proto?tab=readme-ov-file#maturity-level).
Packages suffixed as `experimental` might not be kept indefinitely.

Versioning of modules in this project will be idiomatic of a Go project using [Go modules](https://github.com/golang/go/wiki/Modules).
They will use [semantic import versioning](https://github.com/golang/go/wiki/Modules#semantic-import-versioning).
Meaning modules will comply with [semver 2.0](https://semver.org/spec/v2.0.0.html) with the following exception:

- Packages with an `experimental` suffix do not comply with [semver 2.0](https://semver.org/spec/v2.0.0.html).
- Backwards incompatible changes may be introduced to these packages between minor versions.
- These packages are intended to be temporary.
They will be deprecated and removed when the protobuf definition stabilizes or is removed.
If the protobuf definition stabilizes, the package will be replaced with a stable "non-experimental" package.
If the protobuf definition is removed, the package will be removed without a replacement.

## Getting Started

Expand Down
Loading