open-telemetry / open-telemetry/opentelemetry-ruby
Improve documentation for Baggage class
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 606
- Forks
- 301
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 42
Description
The Baggage class documentation lacks instructions on how to use Baggage. While discussing https://github.com/open-telemetry/opentelemetry-ruby/discussions/1759, we realized we need to make common Baggage processes, like adding baggage to the current context, easier to find.
Improve the Baggage overall class documentation with instructions on how to use it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Baggage class documentation in the repository and review discussion 1759 for the common usage cases to cover. Update the overall class documentation with instructions for adding baggage to the current context and other common Baggage processes. Done means users can find and follow those usage instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100