Minor update to the contributing doc (#707)

* Minor update to the contributing doc

* Update CONTRIBUTING.md

Set core.autocrlf locally.

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

* Update CONTRIBUTING.md

Add more clarity.

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

* Use .gitattributes to make spotless respect line endings

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
This commit is contained in:
Helen Y 2020-07-16 16:58:56 -07:00 committed by GitHub
parent 9f1ffbe38c
commit bbf5e75e63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 3 deletions

5
.gitattributes vendored Normal file
View File

@ -0,0 +1,5 @@
* text=auto eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf

View File

@ -65,7 +65,7 @@ still access helper classes from bootstrap classloader.
#### Agent jar structure #### Agent jar structure
If you now look inside If you now look inside
`java-agent/build/libs/opentelemetry-javaagent-<version>-all.jar`, you will see the `opentelemetry-javaagent/build/libs/opentelemetry-javaagent-<version>-all.jar`, you will see the
following "clusters" of classes: following "clusters" of classes:
- `inst/` - contains `agent-tooling` module and `instrumentation` submodules, loaded and isolated inside - `inst/` - contains `agent-tooling` module and `instrumentation` submodules, loaded and isolated inside
@ -86,10 +86,23 @@ snapshot builds of the `master` branch. They are available from
Build using Java 11: Build using Java 11:
```gradle assemble``` ```bash
java -version
```
```bash
./gradlew assemble
```
and then generate the -all artifact
```bash
./gradlew :opentelemetry-javaagent:shadowJar
```
and then you can find the java agent artifact at and then you can find the java agent artifact at
`java-agent/build/lib/opentelemetry-javaagent-<version>-all.jar`.
`opentelemetry-javaagent/build/lib/opentelemetry-javaagent-<version>-all.jar`.
### Testing ### Testing