Skip to content

Commit

Permalink
Add CONTRIBUTING.md (#596)
Browse files Browse the repository at this point in the history
  • Loading branch information
trask authored Feb 10, 2025
1 parent 1140628 commit 8ec2f23
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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:

```bash
java -version
```

To build the project, run:

```bash
./gradlew assemble
```

## Style guide

This repository follows the OpenTelemetry Java
repository's [style guide](https://github.com/open-telemetry/opentelemetry-java/blob/main/CONTRIBUTING.md#style-guideline).

## 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") }`

0 comments on commit 8ec2f23

Please sign in to comment.