You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,24 @@ If you encounter an issue with the Java SDK, you are welcome to submit a [bug re
4
4
Before that, please search for similar issues. It's possible somebody has encountered this issue already.
5
5
6
6
# 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:
8
8
```sh
9
9
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.
15
16
```
16
17
17
18
# Pull Requests
18
19
19
20
If you want to contribute to the repository, here's a quick guide:
20
21
1. Fork the repository
21
22
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`. 🏁
24
25
* 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.
25
26
* Check for unnecessary whitespace with git diff --check before committing.
0 commit comments