diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48c7c24..7de5fd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,8 @@ ## Contributing +### Instrumenting a library + +When instrumenting a library, it is important to follow the [Trace Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md). ### CI diff --git a/README.md b/README.md index dca2123..8af2c19 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,8 @@ We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and ## Useful links - For more information on OpenTelemetry, visit: -- For help or feedback on this project, join us in [GitHub Discussions][dhttps://github.com/open-telemetry/opentelemetry-erlang-contrib/discussions], `#otel-erlang-elixir` channel in the [CNCF slack](https://slack.cncf.io/), and `#opentelemetry` channel in the [Elixir Lang slack](https://elixir-slackin.herokuapp.com/) +- For conventions used in OpenTelemetry traces, see the following [readme](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md). +- For help or feedback on this project, join us in [GitHub Discussions](https://github.com/open-telemetry/opentelemetry-erlang-contrib/discussions), `#otel-erlang-elixir` channel in the [CNCF slack](https://slack.cncf.io/), and `#opentelemetry` channel in the [Elixir Lang slack](https://elixir-slackin.herokuapp.com/) - Erlang SIG [community page](https://github.com/open-telemetry/community#special-interest-groups) ## License