CONTRIBUTING.md

Contributing

Welcome to the OpenTelemetry Semantic Convention Java repository!

Building

Java 21 or higher is required to build the projects in this repository (the built artifacts can be used on Java 8 or higher). To check your Java version, run:

java -version

To build the project, run:

./gradlew assemble

Generating semantic conventions

Requires docker.

In a shell, execute the following gradle tasks:

./gradlew clean generateSemanticConventions --console=plain
./gradlew spotlessApply

This will download the version of open-telemetry/semantic-conventions defined in the semanticConventionsVersion variable of build.gradle.kts and generate semantic conventions classes from the release contents.

Style guide

This repository follows the OpenTelemetry Java repository's style guide.