Skip to content

[docs/rfc] Add component interface guidelines#14532

Merged
codeboten merged 22 commits into
open-telemetry:mainfrom
jmacd:jmacd/component_interface_v3
Apr 22, 2026
Merged

[docs/rfc] Add component interface guidelines#14532
codeboten merged 22 commits into
open-telemetry:mainfrom
jmacd:jmacd/component_interface_v3

Conversation

@jmacd
Copy link
Copy Markdown
Contributor

@jmacd jmacd commented Feb 4, 2026

Description

Specifies the mechanics of our approach to safe interface evolution.

See #14523
See #14525
See #13902

Testing

This pattern was "tested" in #13241 as I prototyped a rate-limiter extension.

Documentation

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.34%. Comparing base (c62f512) to head (4c1c218).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14532   +/-   ##
=======================================
  Coverage   90.34%   90.34%           
=======================================
  Files         699      699           
  Lines       53748    53748           
=======================================
  Hits        48559    48559           
  Misses       4044     4044           
  Partials     1145     1145           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/rfcs/component-interfaces.md Outdated
Comment thread docs/rfcs/component-interfaces.md Outdated
Comment thread docs/rfcs/component-interfaces.md Outdated
@jmacd jmacd added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 23, 2026
Copy link
Copy Markdown
Contributor

@evan-bradley evan-bradley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing this, I wish I had this document when starting to work on the repo.

Comment thread docs/rfcs/component-interfaces.md
Comment thread docs/rfcs/component-interfaces.md Outdated
Comment thread docs/rfcs/component-interfaces.md Outdated
Comment thread docs/rfcs/component-interfaces.md Outdated
Comment thread docs/rfcs/component-interfaces.md Outdated
@evan-bradley evan-bradley changed the title Component interface guidelines [docs/rfc] Add component interface guidelines Feb 24, 2026
@evan-bradley
Copy link
Copy Markdown
Contributor

Amended the title just to make it a bit clearer this is an RFC.

Also @jmacd could you add a short blurb linking to this document in CONTRIBUTING.md? I think it's a great contributor resource.

@mx-psi
Copy link
Copy Markdown
Member

mx-psi commented Mar 4, 2026

@jmacd Can you make sure you have followed the 'announcement' requirements for RFCs?

@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented Mar 12, 2026

As per #14532 (comment) we should hold off I will announce this as described.

@jmacd jmacd added the ready-to-merge Code review completed; ready to merge by maintainers label Mar 27, 2026
@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented Apr 3, 2026

Fully announced, by now :-)

@mx-psi mx-psi added the rfc:final-comment-period This RFC is in the final comment period phase label Apr 6, 2026
@mx-psi
Copy link
Copy Markdown
Member

mx-psi commented Apr 6, 2026

@jmacd Can you fix the Markdown issues? If CI is fixed, I will merge this on Friday morning unless there are blocking comments by then

@codspeed-hq

This comment was marked as low quality.

@mx-psi
Copy link
Copy Markdown
Member

mx-psi commented Apr 10, 2026

@jmacd I am ready to merge this whenever you fix the checks job

Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
@codeboten codeboten enabled auto-merge April 21, 2026 23:56
@codeboten codeboten added this pull request to the merge queue Apr 22, 2026
Merged via the queue into open-telemetry:main with commit 96c2ea3 Apr 22, 2026
66 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Code review completed; ready to merge by maintainers rfc:final-comment-period This RFC is in the final comment period phase Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants