Contributing

Welcome to the OpenTelemetry Java Examples repository!

Building

Java 17 or higher is required to build the projects in this repository. To check your Java version, run:

java -version

To build the project, run:

./gradlew assemble

Linting

This repository uses flint managed by mise to run the configured lint checks, including Markdown and link validation.

To run all lint checks:

mise run lint

(note: Windows users may need to run mise install first)

To automatically fix fixable issues:

mise run lint:fix

Style guide

This repository follows the OpenTelemetry Java repository's patterns.

Gradle conventions

• Use kotlin instead of groovy
• Plugin versions should be specified in settings.gradle.kts, not in individual modules
• All modules use plugins { id("otel.java-conventions") }