Skip to content

Commit 250434e

Browse files
vancexumfateev
authored andcommitted
Add contribution guide (#299)
1 parent fb04a94 commit 250434e

File tree

2 files changed

+63
-3
lines changed

2 files changed

+63
-3
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Developing cadence-java-client
2+
3+
This doc is intended for contributors to `cadence-java-client` (hopefully that's you!)
4+
5+
**Note:** All contributors also need to fill out the [Uber Contributor License Agreement](http://t.uber.com/cla) before we can merge in any of your changes
6+
7+
## Development Environment
8+
9+
* Java 8.
10+
* Gradle build tool
11+
* Docker
12+
13+
## Licence headers
14+
15+
This project is Open Source Software, and requires a header at the beginning of
16+
all source files. To verify that all files contain the header execute:
17+
18+
```lang=bash
19+
./gradlew licenseCheck
20+
```
21+
22+
To generate licence headers execute
23+
24+
```lang=bash
25+
./gradlew licenseFormat
26+
```
27+
28+
## Commit Messages
29+
30+
Overcommit adds some requirements to your commit messages. At Uber, we follow the
31+
[Chris Beams](http://chris.beams.io/posts/git-commit/) guide to writing git
32+
commit messages. Read it, follow it, learn it, love it.
33+
34+
## Test and Build
35+
36+
Testing and building cadence-java-client requires running cadence docker locally, execute:
37+
38+
```bash
39+
curl -O https://raw.githubusercontent.com/uber/cadence/master/docker/docker-compose.yml
40+
docker-compose up
41+
```
42+
43+
(If this does not work, see instructions for running the Cadence Server at https://github.com/uber/cadence/blob/master/README.md.)
44+
45+
Then run all the tests with:
46+
47+
```bash
48+
./gradlew test
49+
```
50+
51+
Build with:
52+
53+
```bash
54+
./gradlew build
55+
```

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If this does not work, see instructions for running the Cadence Server at https:
2424

2525
[CLI is avaialable as an executable or as a docker image](https://github.com/uber/cadence/blob/master/tools/cli/README.md)
2626

27-
# Build a configuration
27+
## Build a configuration
2828

2929
Add *cadence-client* as a dependency to your *pom.xml*:
3030

@@ -38,9 +38,14 @@ or to *build.gradle*:
3838

3939
compile group: 'com.uber.cadence', name: 'cadence-client', version: '2.4.1'
4040

41-
# Documentation
41+
## Documentation
4242

43-
The documentation on how to use the Cadence Java client is [here](https://cadenceworkflow.io/docs/javaclient/).
43+
The documentation on how to use the Cadence Java client is [here](https://cadenceworkflow.io/docs/04_javaclient/).
4444

4545
Javadocs for the client API are located [here](https://www.javadoc.io/doc/com.uber.cadence/cadence-client).
4646

47+
## Contributing
48+
We'd love your help in making the Cadence Java client great. Please review our [contribution guidelines](CONTRIBUTING.md).
49+
50+
## License
51+
Apache License, please see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)