Skip to content

Commit 9c92bf0

Browse files
Update Guideline for Instr with issues
1 parent d83761f commit 9c92bf0

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,8 @@ The continuous integration overrides that environment variable with as per the c
307307

308308
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.
309309

310+
- 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.
311+
- Be familiar with the [expectations from contributors](#expectations-from-contributors) that apply.
310312
- Follow semantic conventions
311313
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
312314
- 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.

0 commit comments

Comments
 (0)