Skip to content

Commit f00e0e5

Browse files
committed
Add CONTRIBUTING.md
1 parent 1140628 commit f00e0e5

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Welcome to the OpenTelemetry Java Examples repository!
4+
5+
## Building
6+
7+
Java 17 or higher is required to build the projects in this repository.
8+
To check your Java version, run:
9+
10+
```bash
11+
java -version
12+
```
13+
14+
To build the project, run:
15+
16+
```bash
17+
./gradlew assemble
18+
```
19+
20+
## Style guide
21+
22+
See
23+
the [Style guide](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/contributing/style-guideline.md)
24+
from the opentelemetry-java-instrumentation repository.
25+
26+
## Gradle conventions
27+
28+
- Use kotlin instead of groovy
29+
- Plugin versions should be specified in `settings.gradle.kts`, not in individual modules
30+
- All modules use `plugins { id("otel.java-conventions") }`

0 commit comments

Comments
 (0)