Skip to content

Commit 9dba7d5

Browse files
emdnetoxrmx
authored andcommitted
CONTRIBUTING: note to discourage additional contributions that pertain to old HTTP semantic conventions (open-telemetry#2765)
1 parent f54dd46 commit 9dba7d5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Diff for: CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,9 @@ The continuous integration overrides that environment variable with as per the c
250250
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.
251251

252252
- Follow semantic conventions
253-
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs)
253+
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
254+
- 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.
255+
- Contributions related to outdated HTTP semantic conventions (conventions prior to becoming [stable](https://github.com/open-telemetry/semantic-conventions/tree/v1.23.0)) will likely be discouraged, as they increase complexity and the potential for misconceptions.
254256
- Contains a name that is not already claimed in [Pypi](https://pypi.org/). Contact a maintainer, bring the issue up in the weekly Python SIG or create a ticket in Pypi if a desired name has already been taken.
255257
- Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
256258
- Supports auto-instrumentation

0 commit comments

Comments
 (0)