docs: make opentelemetry-proto README consistent with other components#3445
Open
Maximiliano-Zeballos wants to merge 2 commits intoopen-telemetry:mainfrom
Open
docs: make opentelemetry-proto README consistent with other components#3445Maximiliano-Zeballos wants to merge 2 commits intoopen-telemetry:mainfrom
Maximiliano-Zeballos wants to merge 2 commits intoopen-telemetry:mainfrom
Conversation
Add badges (crates.io, docs.rs, license, CI, codecov, Slack), Overview section, crate description, and Getting Started link to match the format used by other components like opentelemetry-stdout. Closes open-telemetry#1306 (partial)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3445 +/- ##
=====================================
Coverage 83.2% 83.2%
=====================================
Files 128 128
Lines 25048 25048
=====================================
+ Hits 20859 20860 +1
+ Misses 4189 4188 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
lalitb
reviewed
Apr 2, 2026
lalitb
approved these changes
Apr 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Updates the
opentelemetry-protoREADME to follow the same structure and format used by other components (e.g.,opentelemetry-stdout):Related Issue
Partial fix for #1306 —
opentelemetry-protowas the component most in need of updates (missing badges and docs.rs link).