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

chore: update guidelines #1882

Merged
merged 1 commit into from
Dec 31, 2023

Conversation

david-luna
Copy link
Contributor

Which problem is this PR solving?

This PR showcases the use of generic types when exporting types to the public API that depend on the instrumented package.

The generic types approach seeks to avoid adding a types package as a dependency of the instrumentation because it may bring some problems to consumers like #1787

This approach has been added as a replacement of the any type approach since its the fallback type when using a generic

Short description of the changes

  • update guildelines doc

cc: @blumamir

@david-luna david-luna requested a review from a team December 27, 2023 11:43
Copy link

codecov bot commented Dec 27, 2023

Codecov Report

Merging #1882 (b0546b1) into main (cf57292) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1882   +/-   ##
=======================================
  Coverage   91.45%   91.45%           
=======================================
  Files         144      144           
  Lines        7406     7406           
  Branches     1483     1483           
=======================================
  Hits         6773     6773           
  Misses        633      633           

Copy link
Member

@blumamir blumamir left a comment

Choose a reason for hiding this comment

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

💯

@blumamir blumamir merged commit ec7125b into open-telemetry:main Dec 31, 2023
14 checks passed
@david-luna david-luna deleted the update-types-guidelines branch June 21, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants