Permalink
May 27, 2014
Oct 21, 2016
Apr 20, 2017
Apr 13, 2017
Feb 22, 2016
Feb 28, 2017
Feb 28, 2017
Mar 9, 2017
Apr 6, 2017
Mar 9, 2017
Mar 20, 2017
Mar 20, 2017
May 27, 2014
Jul 31, 2016
Mar 22, 2017
May 27, 2014
Apr 3, 2017
Aug 18, 2016
Aug 18, 2016
May 27, 2014
Jul 31, 2016
May 27, 2014
Mar 20, 2017
Aug 18, 2016
Mar 20, 2017
Jul 31, 2016
Aug 18, 2016
Jul 31, 2016
Jul 31, 2016
Mar 20, 2017
Oct 28, 2015
Newer
100644
174 lines (136 sloc)
7.42 KB
1
# Contributing to Cockroach
2
8
- A Go environment with a recent 64-bit version of the toolchain. Note that
9
the Makefile enforces the specific version required, as it is updated
10
frequently.
15
- XZ Utils (5.2.3+ is known to work), except on macOS, where xz support is
16
built in to `tar`.
17
- Optional: NodeJS 6.x and Yarn 0.22.0+. Required when compiling protocol
18
buffers.
25
go get -d github.com/cockroachdb/cockroach
26
cd $GOPATH/src/github.com/cockroachdb/cockroach
27
```
30
that the first time you run `make`, it can take some time to download and
31
install various dependencies. After running `make build`, the `cockroach`
32
executable will be in your current directory and can be run as shown in the
37
- The default binary contains core open-source functionally covered by the
38
Apache License 2 (APL2) and enterprise functionality covered by the
39
CockroachDB Community License (CCL). To build a pure open-source (APL2)
40
version excluding enterprise functionality, use `make buildoss`. See this
41
[blog post] for more details.
42
43
[blog post]: https://www.cockroachlabs.com/blog/how-were-building-a-business-to-last/
50
can run `build/builder.sh make generate` from the repository root to get the
51
intended result.
55
- To add or update a Go dependency:
56
- See [`build/README.md`](build/README.md) for details on adding or updating
57
dependencies.
67
+ All contributors need to sign the [Contributor License Agreement](https://cla-assistant.io/cockroachdb/cockroach).
70
If you are working on your own fork, see [this tip](http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html)
74
75
+ Hack away and commit your changes locally using `git add` and `git commit`.
76
Remember to write tests! The following are helpful for running specific
89
# Run a specific sql logic subtest
90
make test PKG=./pkg/sql TESTS='TestLogic$$/select$$'
94
95
Logs are disabled during tests by default. To enable them, include
96
`TESTFLAGS="-v -show-logs"` as an argument the test command:
97
98
```shell
99
make test ... TESTFLAGS="-v -show-logs"
100
```
101
102
When you're ready to commit, be sure to write a Good Commit Message™. Consult
103
https://github.com/erlang/otp/wiki/Writing-good-commit-messages if you're
104
not sure what constitutes a Good Commit Message™.
105
In addition to the general rules referenced above, please also prefix your
106
commit subject line with the affected package, if one can easily be chosen.
107
For example, the subject line of a commit mostly affecting the
108
`server/serverpb` package might read: "server/serverpb: made great again".
109
Commits which affect many packages as a result of a shared dependency change
110
should probably begin their subjects with the name of the shared dependency.
111
Finally, some commits may need to affect many packages in a way which does
112
not point to a specific package; those commits may begin with "*:" or "all:"
113
to indicate their reach.
118
119
+ When you’re ready for review, groom your work: each commit should pass tests
120
and contain a substantial (but not overwhelming) unit of work. You may also
121
want to `git fetch origin` and run
122
`git rebase -i --exec "make check test" origin/master` to make sure you're
123
submitting your changes on top of the newest version of our code. Next, push
125
128
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request). If you know of
129
another GitHub user particularly suited to reviewing your pull request, be
130
sure to mention them in the pull request body. If you possess the necessary
131
GitHub privileges, please also [assign them to the pull request using
132
GitHub's UI](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/).
135
+ If you get a test failure in CircleCI, check the Test Failure tab to see why
136
the test failed. When the failure is logged in `excerpt.txt`, you can find
137
the file from the Artifacts tab and see log messages. (You need to sign in to
140
+ Address feedback by amending your commits. If your change contains multiple
141
commits, address each piece of feedback by amending that commit to which the
142
particular feedback is aimed. Wait (or ask) for new feedback on those
143
commits if they are not straightforward. An `LGTM` ("looks good to me") by
144
someone qualified is usually posted when you're free to go ahead and merge.
145
Most new contributors aren't allowed to merge themselves; in that case, we'll
152
* the [net/trace](https://godoc.org/golang.org/x/net/trace) endpoint at
153
`/debug/requests`. It has a breakdown of the recent traced requests, in
154
particularly slow ones. Two families are traced: `node` and `coord`, the
155
former (and likely more interesting one) containing what happens inside of
156
`Node`/`Store`/`Replica` and the other inside of the coordinator
159
heap and cpu profiles; [this golang blog post](http://blog.golang.org/profiling-go-programs) explains it extremely well and
160
[this one by Dmitry Vuykov](https://software.intel.com/en-us/blogs/2014/05/10/debugging-performance-issues-in-go-programs)
167
make acceptance TESTS='TestPut$$' TESTFLAGS='-v -d 1200s -l .' TESTTIMEOUT=1210s
168
```
169