Permalink
May 27, 2014
May 8, 2015
Nov 3, 2014
Sep 7, 2014
Mar 9, 2015
May 14, 2015
Jun 29, 2015
Jun 29, 2015
Jun 28, 2015
Dec 1, 2014
Oct 24, 2014
May 27, 2014
Oct 6, 2015
May 27, 2014
Oct 6, 2015
May 27, 2014
Oct 6, 2015
Oct 6, 2015
May 27, 2014
Oct 6, 2015
May 27, 2014
Oct 6, 2015
Oct 6, 2015
Oct 6, 2015
Newer
100644
89 lines (65 sloc)
4.49 KB
1
# Contributing to Cockroach
2
6
* A working C++ compiler (on mac os x something like `xcode-select
7
--install` will get you started). The compiler must support C++11
8
(GCC 4.9+ and clang 3.6+ are known to work).
9
* [Go environment](http://golang.org/doc/code.html). Currently a
12
13
If you're on Mac OS X, [homebrew](http://brew.sh/) can be very helpful to fulfill these dependencies.
14
18
mkdir -p $GOPATH/src/github.com/cockroachdb/
19
cd $GOPATH/src/github.com/cockroachdb/
20
git clone git@github.com:cockroachdb/cockroach.git
21
cd cockroach
24
Now you should be all set for `make build`, `make test` and everything else our Makefile has to
25
offer. Note that the first time you run `make` various dependent libraries and tools will be
26
downloaded and installed which can be somewhat time consuming. Be patient.
28
Note that if you edit a `.proto` or `.ts` file, you will need to manually regenerate the associated `.pb.{go,cc,h}` or `.js` files using `go generate ./...`.
29
`go generate` requires a collection of node modules which are installed via npm. If you don't have npm, it typically comes with node. To get it via homebrew:
31
If you're not using homebrew, make sure you install both [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).
35
- `(cd $GOPATH/src && go get -u ./...)` to update the dependencies or `go get {package}` to add a dependency
40
### Style guide
41
We're following the [Google Go Code Review](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) fairly closely. In particular, you want to watch out for proper punctuation and capitalization and make sure that your lines stay well below 80 characters.
42
50
[this tip](http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html)
51
on forking in Go, which ensures that Go import paths will be correct.
54
55
+ Hack away and commit your changes locally using `git add` and `git commit`. Remember to write tests! The following are helpful for running specific subsets of tests:
56
```
57
make test
58
# Run all tests in ./storage
59
make test PKG=./storage
60
# Run all kv tests matching `^TestFoo` with a timeout of 10s
61
make test PKG=./kv TESTS='^TestFoo' TESTTIMEOUT=10s
62
```
63
64
When you're ready to commit, do just that with a succinct title and informative
65
message. For example,
66
67
```bash
68
$ git commit
69
> 'update CONTRIBUTING.md
70
>
71
> Added details on running specific tests via `make`, and
72
> the CircleCI-equivalent test suite.
73
>
74
> Fixed some formatting.'
75
```
77
+ Run the whole CI test suite locally: `./build/circle-local.sh`. This requires the Docker setup; if you don't have/want that, `go generate ./... && make check test testrace` is a good first approximation.
78
79
+ When you’re ready for review, groom your work: each commit should pass tests and contain a substantial (but not overwhelming) unit of work. You may also want to `git fetch origin` and run `git rebase -i --exec "make check test" origin/master` to make sure you're submitting your changes on top of the newest version of our code. Next, push to your fork:
80
83
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request).
85
+ If you get a test failure in CircleCI, check the Test Failure tab to see why the test failed. When the failure is logged in `excerpt.txt`, you can find the file from the Artifacts tab and see log messages. (You need to sign in to see the Artifacts tab.)
87
+ Address feedback in new commits. Wait (or ask) for new feedback on those commits if they are not straightforward. An `LGTM` ("looks good to me") by someone qualified is usually posted when you're free to go ahead and merge. Most new contributors aren't allowed to merge themselves; in that case, we'll do it for you. You may also be asked to re-groom your commits.