Permalink
May 27, 2014
Oct 21, 2016
Feb 22, 2016
Feb 28, 2017
Feb 28, 2017
Mar 9, 2017
Feb 28, 2017
Feb 28, 2017
Mar 9, 2017
Feb 28, 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
Dec 2, 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
168 lines (130 sloc)
7.2 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.
19
go get -d github.com/cockroachdb/cockroach
20
cd $GOPATH/src/github.com/cockroachdb/cockroach
21
```
24
that the first time you run `make`, it can take some time to download and
25
install various dependencies. After running `make build`, the `cockroach`
26
executable will be in your current directory and can be run as shown in the
31
- The default binary contains core open-source functionally covered by the
32
Apache License 2 (APL2) and enterprise functionality covered by the
33
CockroachDB Community License (CCL). To build a pure open-source (APL2)
34
version excluding enterprise functionality, use `make buildoss`. See this
35
[blog post] for more details.
36
37
[blog post]: https://www.cockroachlabs.com/blog/how-were-building-a-business-to-last/
39
- If you edit a `.proto` or `.ts` file, you will need to manually regenerate
40
the associated `.pb.{go,cc,h}` or `.js` files using `go generate ./pkg/...`.
42
- We advise to run `go generate` using our embedded Docker setup.
43
`build/builder.sh` is a wrapper script designed to make this convenient. You
44
can run `build/builder.sh go generate ./pkg/...` from the repository root to
45
get the intended result.
49
- To add or update a Go dependency:
50
- See [`build/README.md`](build/README.md) for details on adding or updating
51
dependencies.
52
- Run `go generate ./pkg/...` to update generated files.
53
- Create a PR with all the changes.
61
+ All contributors need to sign the [Contributor License Agreement](https://cla-assistant.io/cockroachdb/cockroach).
64
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)
68
69
+ Hack away and commit your changes locally using `git add` and `git commit`.
70
Remember to write tests! The following are helpful for running specific
83
# Run a specific sql logic subtest
84
make test PKG=./pkg/sql TESTS='TestLogic$$/select$$'
88
89
Logs are disabled during tests by default. To enable them, include
90
`TESTFLAGS="-v -show-logs"` as an argument the test command:
91
92
```shell
93
make test ... TESTFLAGS="-v -show-logs"
94
```
95
96
When you're ready to commit, be sure to write a Good Commit Message™. Consult
97
https://github.com/erlang/otp/wiki/Writing-good-commit-messages if you're
98
not sure what constitutes a Good Commit Message™.
99
In addition to the general rules referenced above, please also prefix your
100
commit subject line with the affected package, if one can easily be chosen.
101
For example, the subject line of a commit mostly affecting the
102
`server/serverpb` package might read: "server/serverpb: made great again".
103
Commits which affect many packages as a result of a shared dependency change
104
should probably begin their subjects with the name of the shared dependency.
105
Finally, some commits may need to affect many packages in a way which does
106
not point to a specific package; those commits may begin with "*:" or "all:"
107
to indicate their reach.
109
+ Run the test suite locally:
110
111
`go generate ./pkg/... && make check test testrace`
112
113
+ When you’re ready for review, groom your work: each commit should pass tests
114
and contain a substantial (but not overwhelming) unit of work. You may also
115
want to `git fetch origin` and run
116
`git rebase -i --exec "make check test" origin/master` to make sure you're
117
submitting your changes on top of the newest version of our code. Next, push
119
122
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request). If you know of
123
another GitHub user particularly suited to reviewing your pull request, be
124
sure to mention them in the pull request body. If you possess the necessary
125
GitHub privileges, please also [assign them to the pull request using
126
GitHub's UI](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/).
129
+ If you get a test failure in CircleCI, check the Test Failure tab to see why
130
the test failed. When the failure is logged in `excerpt.txt`, you can find
131
the file from the Artifacts tab and see log messages. (You need to sign in to
134
+ Address feedback by amending your commits. If your change contains multiple
135
commits, address each piece of feedback by amending that commit to which the
136
particular feedback is aimed. Wait (or ask) for new feedback on those
137
commits if they are not straightforward. An `LGTM` ("looks good to me") by
138
someone qualified is usually posted when you're free to go ahead and merge.
139
Most new contributors aren't allowed to merge themselves; in that case, we'll
146
* the [net/trace](https://godoc.org/golang.org/x/net/trace) endpoint at
147
`/debug/requests`. It has a breakdown of the recent traced requests, in
148
particularly slow ones. Two families are traced: `node` and `coord`, the
149
former (and likely more interesting one) containing what happens inside of
150
`Node`/`Store`/`Replica` and the other inside of the coordinator
153
heap and cpu profiles; [this golang blog post](http://blog.golang.org/profiling-go-programs) explains it extremely well and
154
[this one by Dmitry Vuykov](https://software.intel.com/en-us/blogs/2014/05/10/debugging-performance-issues-in-go-programs)
161
make acceptance TESTS='TestPut$$' TESTFLAGS='-v -d 1200s -l .' TESTTIMEOUT=1210s
162
```
163