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.

Sign up for GitHub

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

Jump to bottom

Interface stability documentation #2012

Merged
merged 5 commits into from
Jun 18, 2021
Merged

Interface stability documentation #2012

merged 5 commits into from
Jun 18, 2021

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Jun 17, 2021 •
edited
Loading

  • 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 •
edited
Loading

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 force-pushed the interface-stability branch from 9637111 to a01f2fb Compare June 17, 2021 19:03
@MrAlias MrAlias force-pushed the interface-stability branch from 8795223 to c5b5ae6 Compare June 17, 2021 23:40
@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
@MrAlias MrAlias merged commit 694c9a4 into open-telemetry:main Jun 18, 2021
@MrAlias MrAlias deleted the interface-stability branch June 18, 2021 14:56
@MrAlias MrAlias mentioned this pull request Oct 20, 2022
Closed
@MrAlias MrAlias mentioned this pull request Nov 6, 2022
Merged
@MrAlias MrAlias mentioned this pull request Feb 3, 2023
Closed
@MrAlias MrAlias mentioned this pull request Jul 31, 2023
Merged
@pellared pellared added this to the untracked milestone Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmacd jmacd jmacd approved these changes

@dashpole dashpole dashpole approved these changes

@Aneurysm9 Aneurysm9 Aneurysm9 approved these changes

@evantorrie evantorrie Awaiting requested review from evantorrie

@MadVikingGod MadVikingGod Awaiting requested review from MadVikingGod

@paivagustavo paivagustavo Awaiting requested review from paivagustavo

@XSAM XSAM Awaiting requested review from XSAM XSAM is a code owner

Assignees
No one assigned
Labels
documentation Provides helpful information Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
untracked
Development

Successfully merging this pull request may close these issues.

Develop and implement a plan to extend interfaces
5 participants
@MrAlias @Aneurysm9 @dashpole @jmacd @pellared