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

Interface stability documentation #2012

Merged
merged 5 commits into from Jun 18, 2021

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Jun 17, 2021

  • Update the project versioning policy to call out interfaces can be extended.
  • Update project contributing documentation with information on how and when interfaces can be extended.
  • Add documentation to exported information about their stability or developer comments stating they cannot be changed.

Resolves #1714

@codecov
Copy link

codecov bot commented Jun 17, 2021

Codecov Report

Merging #2012 (37b9eb7) into main (39fe809) will increase coverage by 0.0%.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #2012   +/-   ##
=====================================
  Coverage   73.0%   73.0%           
=====================================
  Files        171     171           
  Lines       8687    8687           
=====================================
+ Hits        6346    6348    +2     
+ Misses      2072    2070    -2     
  Partials     269     269           
Impacted Files Coverage Δ
propagation/propagation.go 78.5% <ø> (ø)
sdk/resource/auto.go 87.5% <ø> (ø)
sdk/trace/id_generator.go 100.0% <ø> (ø)
sdk/trace/sampling.go 100.0% <ø> (ø)
sdk/trace/span.go 88.9% <ø> (ø)
trace/trace.go 98.2% <ø> (ø)
exporters/jaeger/jaeger.go 94.2% <0.0%> (+1.1%) ⬆️

@MrAlias MrAlias added this to In progress in OpenTelemetry Go 1.0.0 via automation Jun 17, 2021
@MrAlias MrAlias added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jun 17, 2021
@MrAlias MrAlias added the documentation Provides helpful information label Jun 17, 2021
@MrAlias MrAlias marked this pull request as ready for review June 17, 2021 23:46
OpenTelemetry Go 1.0.0 automation moved this from In progress to Reviewer approved Jun 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Provides helpful information Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Develop and implement a plan to extend interfaces
4 participants