Skip to content

Commit 67c8e74

Browse files
authored
[chore] Update contributing docs with SemConv compatibility guideline (#40407)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description After the merge of open-telemetry/opentelemetry-collector#13101 we can update contrib's contribution guidelines to point back to the same Semantic Conventions' compatibility guideline. <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes open-telemetry/opentelemetry-collector#13076 <!--Describe what testing was performed and which tests were added.--> #### Testing ~ <!--Describe the documentation added.--> #### Documentation Added <!--Please delete paragraphs that you did not use before submitting.--> Signed-off-by: ChrsMark <[email protected]>
1 parent b1dda9f commit 67c8e74

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,12 @@ After a component has been merged it must be added to the
324324
[OpenTelemetry Collector Contrib's release manifest.yaml](https://github.com/open-telemetry/opentelemetry-collector-releases/blob/main/distributions/otelcol-contrib/manifest.yaml)
325325
to be included in the distributed otelcol-contrib binaries and docker images.
326326
327+
## Semantic Conventions compatibility
328+
329+
When introducing new metrics, attributes or entity attributes to components, ensure that
330+
[Semantic Conventions' compatibility guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md#semantic-conventions-compatibility)
331+
are taken into account.
332+
327333
## Adding metrics to existing receivers
328334
Following these steps for contributing additional metrics to existing receivers.
329335
- Read instructions [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#fork) on how to

0 commit comments

Comments
 (0)