Skip to content

Commit d52d773

Browse files
authored
Update CONTRIBUTING.md
1 parent f45525f commit d52d773

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

.github/CONTRIBUTING.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
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-
61
# Issues
72

83
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).
94
Before that, please search for similar issues. It's possible somebody has encountered this issue already.
105

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+
1117
# Pull Requests
1218

1319
If you want to contribute to the repository, here's a quick guide:
@@ -48,24 +54,6 @@ By making a contribution to this project, I certify that:
4854
maintained indefinitely and may be redistributed consistent with
4955
this project or the open source license(s) involved.
5056

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-
6957
## Additional Resources
7058
+ [General GitHub documentation](https://help.github.com/)
7159
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)

0 commit comments

Comments
 (0)