Skip to content

Commit

Permalink
Clarify maturity guarantees (#225)
Browse files Browse the repository at this point in the history
* Clarify maturity guarantees

This clarifies what is and is not part of the promises.

* Made a few fixes based on PR comments
  • Loading branch information
tigrannajaryan authored Oct 20, 2020
1 parent 30d237e commit 69d265b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ All messages | Alpha |
(See [maturity-matrix.yaml](https://github.com/open-telemetry/community/blob/47813530864b9fe5a5146f466a58bd2bb94edc72/maturity-matrix.yaml#L57)
for definition of maturity levels).

Note that maturity guarantees apply only to wire-level compatibility for the binary
Protobuf serialization. Neither message, field, nor enum names of Protobuf messages
are visible on the wire and are not considered part of the guarantees. We are free
to make change to the names.

In the future when OTLP/JSON is declared stable, field names will also become part of
the maturity guarantees, since field names are visible on the wire for JSON encoding.

## Experiments

In some cases we are trying to experiment with different features. In this case
Expand Down

0 comments on commit 69d265b

Please sign in to comment.