open-telemetry
/
opentelemetry-java-contrib
mirror of https://github.com/open-telemetry/opentelemetry-java-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md (#301) 

* Add CONTRIBUTING.md

* updates

* updates

* fix

* Update CONTRIBUTING.md

Co-authored-by: Anuraag Agrawal <anuraaga@gmail.com>

Co-authored-by: Anuraag Agrawal <anuraaga@gmail.com>
This commit is contained in:
Trask Stalnaker 2022-04-19 12:12:23 -07:00 committed by GitHub
parent 77424ad1bf
commit 7ca173bf94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,35 @@
## Contributing
Pull requests for bug fixes are always welcome!
Before submitting new features or changes to current functionality, it is recommended to first
[open an issue](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/new)
and discuss your ideas or propose the changes you wish to make.
### Building
In order to build and test this whole repository you need JDK 11+.
#### Snapshot builds
For developers testing code changes before a release is complete, there are
snapshot builds of the `main` branch. They are available from
the Sonatype OSS snapshots repository at `https://oss.sonatype.org/content/repositories/snapshots/`
([browse](https://oss.sonatype.org/content/repositories/snapshots/io/opentelemetry/contrib/))
#### Building from source
Building using Java 11+:
```bash
java -version
```
```bash
./gradlew assemble
```
### Style guide
See the [Style guide](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/contributing/style-guideline.md)
from the opentelemetry-java-instrumentation repository.