Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.3 KB
Raw

Developing cadence-java-client

This doc is intended for contributors to cadence-java-client (hopefully that's you!)

Note: All contributors also need to fill out the Uber Contributor License Agreement before we can merge in any of your changes

Development Environment

  • Java 8.
  • Gradle build tool
  • Docker

Licence headers

This project is Open Source Software, and requires a header at the beginning of all source files. To verify that all files contain the header execute:

./gradlew licenseCheck

To generate licence headers execute

./gradlew licenseFormat

Commit Messages

Overcommit adds some requirements to your commit messages. At Uber, we follow the Chris Beams guide to writing git commit messages. Read it, follow it, learn it, love it.

Test and Build

Testing and building cadence-java-client requires running cadence docker locally, execute:

curl -O https://raw.githubusercontent.com/uber/cadence/master/docker/docker-compose.yml
docker-compose up

(If this does not work, see instructions for running the Cadence Server at https://github.com/uber/cadence/blob/master/README.md.)

Then run all the tests with:

./gradlew test

Build with:

./gradlew build