Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing instructions #3242

Merged
merged 3 commits into from
May 19, 2020
Merged

Update contributing instructions #3242

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7fa658
Update contributing instructions
sheerun May 7, 2020
521ab7a
Merge branch 'master' into update-contributing
meiliang86 May 8, 2020
2fec5d1
Merge branch 'master' into update-contributing
vancexu May 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,6 @@ 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](https://golang.github.io/dep/). 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
Expand Down Expand Up @@ -67,17 +59,25 @@ make bins

## Testing

Before running the tests you must have `cassandra` and `kafka` running locally:
Before running the tests you must have `cassandra`, `kafka`, and its `zookeeper` dependency:

```bash
# for OS X
# install cassandra
# you can reduce memory used by cassandra (by default 4GB), by following instructions here: http://codefoundries.com/developer/cassandra/cassandra-installation-mac.html
brew install cassandra

# start cassandra
/usr/local/bin/cassandra
```
# install zookeeper compatible with jdk@8 that OSX has
brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/6d8197bbb5f77e62d51041a3ae552ce2f8ff1344/Formula/zookeeper.rb

To run kafka, follow kafka quickstart guide [here](https://kafka.apache.org/quickstart)
# install kafka compatible with zookeeper 3.4.14
brew install --ignore-dependencies https://raw.githubusercontent.com/Homebrew/homebrew-core/6d8197bbb5f77e62d51041a3ae552ce2f8ff1344/Formula/kafka.rb

# start services
brew services start cassandra
brew services start zookeeper
brew services start kafka

```

Run all the tests:

Expand All @@ -93,5 +93,5 @@ 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
go test -v github.com/uber/cadence/common/persistence/persistence-tests -run TestVisibilitySamplingSuite -testify.m TestListClosedWorkflowExecutions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep this unchanged?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess, but old one isn't working, there is no TestCassandraPersistenceSuite in this directory. Do you still want me to revert?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@meiliang86 ping

```