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
May 27, 2014
May 27, 2014
Apr 25, 2015
Sep 10, 2014
May 27, 2014
May 27, 2014
Sep 7, 2014
Sep 10, 2014
Apr 21, 2015
Sep 10, 2014
Newer
100644
78 lines (53 sloc)
4.1 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
56
58
59
+ Run tests. It's usually enough to run `make test testrace`. You can also run `make acceptance` to have better test coverage. Running acceptance tests requires the Docker setup.
60
61
+ When you’re ready for review, create a remote branch from your local branch. You may want to `git fetch origin` and run `git rebase origin/master` on your local feature branch before.
62
64
65
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request).
66
67
+ Address feedback in new commits. Wait (or ask) for new feedback on those commits if they are not straightforward.
68
69
+ Once ready to land your change, squash your commits. Where n is the number of commits in your branch, run
70
`git rebase -i HEAD~n`
71
72
and subsequently update your remote (you will have to force the push, `git push -f $USER mybranch`). The pull request will update.
73
74
+ If you do not have write access to the repository and your pull request requires a manual merge, you may be asked to rebase again,
75
`git fetch origin; git rebase -i origin/master` and update the PR again. Otherwise, you are free to merge your branch into origin/master directly or rebase first as you deem appropriate.
76