Skip to content

Commit da6f934

Browse files
committed
chore(contributing.md): update contributing.md to use maven instead of gradle
1 parent b0f7f2a commit da6f934

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,24 @@ If you encounter an issue with the Java SDK, you are welcome to submit a [bug re
44
Before that, please search for similar issues. It's possible somebody has encountered this issue already.
55

66
# Building and testing
7-
This project uses [Gradle] as the build tool (> v1.x). Here are some helpful commands:
7+
This project uses [Maven] as the build tool (> v1.x). Here are some helpful commands:
88
```sh
99
cd java-sdk
10-
gradle jar # build jar file (build/libs/watson-developer-cloud-6.14.0.jar)
11-
gradle test # run tests
12-
gradle check # performs quality checks on source files and generates reports
13-
gradle testReport # run tests and generate the aggregated test report (build/reports/allTests)
14-
gradle codeCoverageReport # run tests and generate the code coverage report (build/reports/jacoco)
10+
mvn clean # Delete target directory.
11+
mvn test # Run tests
12+
mvn package # Take the compiled code and package it in its distributable format, e.g. JAR.
13+
mvn verify # Run any checks to verify the MVN package is valid and meets quality criteria.
14+
mvn verify -fae -DskipITs=false # Run Integration tests to verify the MVN package is valid and meets quality criteria.
15+
mvn install # Install the package into the local repository.
1516
```
1617

1718
# Pull Requests
1819

1920
If you want to contribute to the repository, here's a quick guide:
2021
1. Fork the repository
2122
1. Edit the [`config.properties`](../common/src/test/resources/config.properties) file to add your service credentials to the appropriate fields.
22-
2. develop and test your code changes, gradle: `gradle test`.
23-
* Run `checkstyle`: `gradle checkstyle`. 🏁
23+
2. develop and test your code changes, gradle: `mvn verify -fae -DskipITs=false`.
24+
* Run `checkstyle`: `mvn checkstyle:check`. 🏁
2425
* Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
2526
* Check for unnecessary whitespace with git diff --check before committing.
2627
3. Make the test pass

0 commit comments

Comments
 (0)