Skip to content

Commit

Permalink
Daniel Dyla Suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
bobstrecansky committed Dec 19, 2020
1 parent 4458d60 commit bcc8577
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ This project uses [semver v2](https://semver.org/), as does the rest of OpenTele

#### SDK Stability:
* Public portions of the SDK (constructors, configuration, end-user interfaces) must remain backwards compatible.
* Internal interfaces may break with a minor version change.
* No existing public method names or signatures will change with a patch release.
* Public method signatures may only change in a backwards compatible way with a minor release.

Expand All @@ -19,13 +18,12 @@ This project uses [semver v2](https://semver.org/), as does the rest of OpenTele
* Public portions of the SDK (constructors, configuration, end-user interfaces) must remain backwards compatible.
* Internal interfaces are allowed to break.
* API modules for mature (i.e. released) signals will be transitive dependencies of the OpenTelemetry API class.
* Methods for accessing mature APIs will be added, as appropriate to the OpenTelemetry interface.
* Methods for accessing mature APIs will be added, as appropriate to the OpenTelemetry API interface.
* SDK modules for mature (i.e. released) signals will be transitive dependencies of the SDK.
* Configuration options for the SDK modules for mature signals will be exposed, as appropriate, on the OpenTelemetry SDK class.

#### Immature or experimental signals
* API namespaces for immature signals will not be transitive dependencies of the API class.
* API namespaces will be named with an "-experimental" suffix to make it abundantly clear that depending on them is at your own risk.
* API namespaces for immature signals will be co-versioned along with mature API namespaces.
* The classes for immature APIs will be used as if they were mature signals. This will enable users to easily transition from immature to mature usage, without having to change imports.
* SDK classes for immature signals will also be named with an "-experimental" suffix, in parallel to their API modules.

0 comments on commit bcc8577

Please sign in to comment.