Skip to content

Enhance README consistency across OpenTelemetry components #3074

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 17, 2025

This PR addresses inconsistencies in README files across OpenTelemetry Rust components to provide a uniform documentation experience for users.

Changes Made

Enhanced opentelemetry-http README

  • Added comprehensive "What does this crate contain?" section detailing:
    • Context propagation capabilities
    • HTTP client support (reqwest, hyper)
    • Exporter utilities
    • Sampling strategy support
  • Added "Related crates" section linking to core OpenTelemetry components
  • Improved description clarity with explicit OpenTelemetry integration mention

Improved opentelemetry-stdout README

  • Enhanced description to clearly explain educational/debugging purpose
  • Improved "What does this crate contain?" section with detailed descriptions of:
    • Trace exporter functionality
    • Metrics exporter capabilities
    • Logs exporter features
  • Clarified human-readable output format and use cases

Fixed opentelemetry-proto README

  • Added missing badges (crates.io, docs.rs, LICENSE, CI, Slack)
  • Improved description clarity and formatting
  • Added "Getting started" section for consistency

Enhanced opentelemetry-appender-log README

  • Added missing "Getting started" section
  • Added complete "Supported Rust Versions" section
  • Added missing reference links

Updated opentelemetry-semantic-conventions README

  • Added missing "Getting started" section for consistency

Structure Consistency

All README files now follow a consistent structure:

  1. Title with OpenTelemetry logo
  2. Clear description with purpose
  3. Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack)
  4. Overview section
  5. "What does this crate contain?" section (where applicable)
  6. "Getting started" section linking to docs
  7. Release notes section
  8. Supported Rust versions section

This ensures users can easily navigate documentation and find relevant information across all OpenTelemetry Rust components.

Fixes #1306.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link

linux-foundation-easycla bot commented Jul 17, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

Co-authored-by: cijothomas <5232798+cijothomas@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Consistent readme file for all components Enhance README consistency across OpenTelemetry components Jul 17, 2025
@Copilot Copilot AI requested a review from cijothomas July 17, 2025 02:40
Copilot finished work on behalf of cijothomas July 17, 2025 02:40
@cijothomas
Copy link
Member

@copilot
make sure the following is checked for every crate in this repo (except examples)

All README files now follow a consistent structure:

Title with OpenTelemetry logo
Clear description with purpose
Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack)
Overview section
"What does this crate contain?" section (where applicable)
"Getting started" section linking to docs
Release notes section
Supported Rust versions section

Copy link

codecov bot commented Jul 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.1%. Comparing base (0462369) to head (d9ea1e6).

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #3074   +/-   ##
=====================================
  Coverage   80.1%   80.1%           
=====================================
  Files        126     126           
  Lines      21957   21957           
=====================================
  Hits       17603   17603           
  Misses      4354    4354           

☔ 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.

Co-authored-by: cijothomas <5232798+cijothomas@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jul 17, 2025

@copilot
make sure the following is checked for every crate in this repo (except examples)

...

Completed comprehensive README consistency check for all OpenTelemetry Rust crates. All 12 crates now follow the required structure:

✅ Title with OpenTelemetry logo
✅ Clear description with purpose
✅ Complete badge set (crates.io, docs.rs, LICENSE, CI, Slack)
✅ Overview section
✅ "What does this crate contain?" section (where applicable)
✅ "Getting started" section linking to docs
✅ Release notes section
✅ Supported Rust versions section

Changes in commit 6f990f5.

Copilot finished work on behalf of cijothomas July 17, 2025 02:49
@cijothomas cijothomas closed this Aug 2, 2025
@cijothomas cijothomas reopened this Aug 2, 2025
@cijothomas
Copy link
Member

/easycla

1 similar comment
@lukaszgryglicki
Copy link

/easycla

@lukaszgryglicki
Copy link

@cijothomas EasyCLA now passes as requested on slack.

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.

Consistent readme file for all components
3 participants