Permalink
May 27, 2014
Oct 21, 2016
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
177 lines (138 sloc)
7.4 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.
16
- Optional: NodeJS 6.x and Yarn 0.22.0+. Required when compiling protocol
17
buffers.
24
go get -d github.com/cockroachdb/cockroach
25
cd $GOPATH/src/github.com/cockroachdb/cockroach
26
```
29
that the first time you run `make`, it can take some time to download and
30
install various dependencies. After running `make build`, the `cockroach`
31
executable will be in your current directory and can be run as shown in the
36
- The default binary contains core open-source functionally covered by the
37
Apache License 2 (APL2) and enterprise functionality covered by the
38
CockroachDB Community License (CCL). To build a pure open-source (APL2)
39
version excluding enterprise functionality, use `make buildoss`. See this
40
[blog post] for more details.
41
42
[blog post]: https://www.cockroachlabs.com/blog/how-were-building-a-business-to-last/
49
can run `build/builder.sh make generate` from the repository root to get the
50
intended result.
54
- To add or update a Go dependency:
55
- See [`build/README.md`](build/README.md) for details on adding or updating
56
dependencies.
66
+ All contributors need to sign the [Contributor License Agreement](https://cla-assistant.io/cockroachdb/cockroach).
69
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)
73
74
+ Hack away and commit your changes locally using `git add` and `git commit`.
75
Remember to write tests! The following are helpful for running specific
88
# Run a specific sql logic subtest
89
make test PKG=./pkg/sql TESTS='TestLogic$$/select$$'
93
94
Logs are disabled during tests by default. To enable them, include
95
`TESTFLAGS="-v -show-logs"` as an argument the test command:
96
97
```shell
98
make test ... TESTFLAGS="-v -show-logs"
99
```
100
101
When you're ready to commit, be sure to write a Good Commit Message™. Consult
102
https://github.com/erlang/otp/wiki/Writing-good-commit-messages if you're
103
not sure what constitutes a Good Commit Message™.
104
In addition to the general rules referenced above, please also prefix your
105
commit subject line with the affected package, if one can easily be chosen.
106
For example, the subject line of a commit mostly affecting the
107
`server/serverpb` package might read: "server/serverpb: made great again".
108
Commits which affect many packages as a result of a shared dependency change
109
should probably begin their subjects with the name of the shared dependency.
110
Finally, some commits may need to affect many packages in a way which does
111
not point to a specific package; those commits may begin with "*:" or "all:"
112
to indicate their reach.
121
122
+ When you’re ready for review, groom your work: each commit should pass tests
123
and contain a substantial (but not overwhelming) unit of work. You may also
124
want to `git fetch origin` and run
128
131
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request). If you know of
132
another GitHub user particularly suited to reviewing your pull request, be
133
sure to mention them in the pull request body. If you possess the necessary
134
GitHub privileges, please also [assign them to the pull request using
135
GitHub's UI](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/).
138
+ If you get a test failure in CircleCI, check the Test Failure tab to see why
139
the test failed. When the failure is logged in `excerpt.txt`, you can find
140
the file from the Artifacts tab and see log messages. (You need to sign in to
143
+ Address feedback by amending your commits. If your change contains multiple
144
commits, address each piece of feedback by amending that commit to which the
145
particular feedback is aimed. Wait (or ask) for new feedback on those
146
commits if they are not straightforward. An `LGTM` ("looks good to me") by
147
someone qualified is usually posted when you're free to go ahead and merge.
148
Most new contributors aren't allowed to merge themselves; in that case, we'll
155
* the [net/trace](https://godoc.org/golang.org/x/net/trace) endpoint at
156
`/debug/requests`. It has a breakdown of the recent traced requests, in
157
particularly slow ones. Two families are traced: `node` and `coord`, the
158
former (and likely more interesting one) containing what happens inside of
159
`Node`/`Store`/`Replica` and the other inside of the coordinator
162
heap and cpu profiles; [this golang blog post](http://blog.golang.org/profiling-go-programs) explains it extremely well and
163
[this one by Dmitry Vuykov](https://software.intel.com/en-us/blogs/2014/05/10/debugging-performance-issues-in-go-programs)
170
make acceptance TESTS='TestPut$$' TESTFLAGS='-v -d 1200s -l .' TESTTIMEOUT=1210s
171
```
172