Skip to content

Update "Guideline for Instrumentations" with Issue requirement and Native instrumentation tip #4464

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.

Sign up for GitHub

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

Open
tammy-baylis-swi wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −0
Open

Update "Guideline for Instrumentations" with Issue requirement and Native instrumentation tip #4464

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c92bf0
Update Guideline for Instr with issues
tammy-baylis-swi Apr 17, 2026
9da1fe7
Add guidelines-for-native
tammy-baylis-swi Apr 20, 2026
7589060
Merge branch 'main' into add-issues-guideline
tammy-baylis-swi Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,8 @@ The continuous integration overrides that environment variable with as per the c

Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.

- Find or Create a new [Issue](https://github.com/open-telemetry/opentelemetry-python-contrib/issues) describing the framework to instrument and its use cases to support with OpenTelemetry.
- Be familiar with the [expectations from contributors](#expectations-from-contributors) that apply.
- Follow semantic conventions
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
- To ensure consistency, we encourage contributions that align with [STABLE](https://opentelemetry.io/docs/specs/otel/document-status/#lifecycle-status) semantic conventions if available. This approach helps us avoid potential confusion and reduces the need to support multiple outdated versions of semantic conventions. However, we are still open to considering exceptional cases where changes are well justified.
Expand Down
Loading