Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.44 KB
Raw

Developing cadence-client

This doc is intended for contributors to cadence-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

  • Go. Install on OS X with brew install go. The minimum required Go version is 1.10.
  • thrift. Install on OS X with brew install thrift.
  • thrift-gen. Install with go get github.com/uber/tchannel-go/thrift/thrift-gen.

Checking out the code

Make sure the repository is cloned to the correct location: (Note: the path is go.uber.org/cadence/ instead of github repo)

go get go.uber.org/cadence/...
cd $GOPATH/src/go.uber.org/cadence

Dependency management

Dependencies are tracked via Gopkg.toml. If you're not familiar with dep, read the docs.

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:

make copyright

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.

Testing

Run all the tests with coverage and race detector enabled:

make test