|
1 | | -# Questions |
2 | | - |
3 | | -If you are having difficulties using the APIs or have a question about the IBM Watson Services, |
4 | | -please ask a question on [dW Answers][dw] or [Stack Overflow][stackoverflow]. |
5 | | - |
6 | 1 | # Issues |
7 | 2 |
|
8 | 3 | If you encounter an issue with the Java SDK, you are welcome to submit a [bug report](https://github.com/watson-developer-cloud/java-sdk/issues). |
9 | 4 | Before that, please search for similar issues. It's possible somebody has encountered this issue already. |
10 | 5 |
|
| 6 | +# Building and testing |
| 7 | +This project uses [Gradle] as the build tool (> v1.x). Here are some helpful commands: |
| 8 | +```sh |
| 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) |
| 15 | +``` |
| 16 | + |
11 | 17 | # Pull Requests |
12 | 18 |
|
13 | 19 | If you want to contribute to the repository, here's a quick guide: |
14 | 20 | 1. Fork the repository |
15 | | - 1. Create a `.config.properties` similar to [`config.properties`](https://github.com/watson-developer-cloud/java-sdk/blob/master/core/src/test/resources/config.properties). |
| 21 | + 1. Edit the [`config.properties`](../common/src/test/resources/config.properties) file to add your service credentials to the appropriate fields. |
16 | 22 | 2. develop and test your code changes, gradle: `gradle test`. |
17 | 23 | * Run `checkstyle`: `gradle checkstyle`. 🏁 |
18 | 24 | * 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. |
@@ -48,24 +54,6 @@ By making a contribution to this project, I certify that: |
48 | 54 | maintained indefinitely and may be redistributed consistent with |
49 | 55 | this project or the open source license(s) involved. |
50 | 56 |
|
51 | | -## Emoji Cheatsheet |
52 | | - |
53 | | -When creating creating commits or updating the `CHANGELOG`, please **start** the commit message or update with one of the following applicable Emoji. Emoji should not be used at the start of issue or pull request titles. |
54 | | - |
55 | | -* :new: `:new:` when adding new functionality |
56 | | -* :bug: `:bug:` when fixing a bug |
57 | | -* :memo: `:memo:` when writing documentation |
58 | | -* :art: `:art:` when improving the format/structure of the code |
59 | | -* :fire: `:fire:` when removing code or files |
60 | | -* :racehorse: `:racehorse:` when improving performance |
61 | | -* :white_check_mark: `:white_check_mark:` when adding tests |
62 | | -* :green_heart: `:green_heart:` when fixing the CI build |
63 | | -* :lock: `:lock:` when dealing with security |
64 | | -* :crystal_ball: `:crystal_ball:` when experimenting |
65 | | -* :unamused: `:unamused:` when doing chore work (updating dependencies, etc…) |
66 | | -* :boom: `:boom:` when changing in a non-backwards-compatible way current functionality |
67 | | -* :shipit: `:shipit:` when creating a new release |
68 | | - |
69 | 57 | ## Additional Resources |
70 | 58 | + [General GitHub documentation](https://help.github.com/) |
71 | 59 | + [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
|
0 commit comments