-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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") }` |