Skip to content

Commit

Permalink
Add Versioning Policy to README (#167)
Browse files Browse the repository at this point in the history
With the OTel Profiling signal v1experimental was introduced. This might break backwards compatability if v1experimental gets  replaced with v1.
Add a section to the Readme to make users aware of this risk.
  • Loading branch information
florianl authored May 9, 2024
1 parent af7b8fb commit cfa3298
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

Generated Go code for the OpenTelemetry protobuf data model.

## Versioning Policy

The autogenerated 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.

## Getting Started

Install the latest version in your project.
Expand Down

0 comments on commit cfa3298

Please sign in to comment.