open-telemetry / open-telemetry/opentelemetry-python-contrib
Add note to contributing guide about instrumentation name
Open
Beginner friendly
Nobody has claimed this yet.
documentation
good first issue
help wanted
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
A followup to https://github.com/open-telemetry/opentelemetry-python/issues/2457, instrumentation names should use a canonical identifier used anywhere the instrumentation needs to obtain a tracer. This should be reflected in the contributing guide.
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
Start with the contributing guide and review issue #2457 for the canonical instrumentation-name guidance. Update the guide to state that the same identifier must be used wherever the instrumentation obtains a tracer, then verify the wording is clear and consistent with the existing guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100