Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

97 lines (65 loc) · 2.78 KB
Raw

Developing Cadence

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

Checking out the code

Make sure the repository is cloned to the correct location:

cd $GOPATH
git clone https://github.com/uber/cadence.git src/github.com/uber/cadence
cd $GOPATH/src/github.com/uber/cadence

Dependency management

Dependencies are recorded in Gopkg.toml and managed by dep. If you're not familiar with dep, read the docs. The Makefile will call install-dep.sh to install dep on Mac or Linux. You can use this script directly, but it will be run automatically with make commands. To check dependencies, run dep ensure.

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 And Titles of Pull Requests

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.

All commit messages are from the titles of your pull requests. So make sure follow the rules when titling them. Please don't use very generic titles like "bug fixes".

All PR titles should start with UPPER case.

Examples:

Issues to start with

Take a look at the list of issues labeled up-for-grabs. These issues are a great way to start contributing to Cadence.

Building

You can compile the cadence service and helper tools without running test:

make bins

Testing

Before running the tests you must have cassandra and kafka running locally:

# for OS X
brew install cassandra

# start cassandra
/usr/local/bin/cassandra

To run kafka, follow kafka quickstart guide here

Run all the tests:

make test

# `make test` currently do not include crossdc tests, start kafka and run 
make test_xdc

# or go to folder with *_test.go, e.g
cd service/history/ 
go test -v
# run single test
go test -v <path> -run <TestSuite> -testify.m <TestSpercificTaskName>
# example:
go test -v github.com/uber/cadence/common/persistence -run TestCassandraPersistenceSuite -testify.m TestPersistenceStartWorkflow