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
May 27, 2014
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
153 lines (117 sloc)
6.76 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
80
81
When you're ready to commit, be sure to write a Good Commit Message™. Consult
82
https://github.com/erlang/otp/wiki/Writing-good-commit-messages if you're
83
not sure what constitutes a Good Commit Message™.
84
In addition to the general rules referenced above, please also prefix your
85
commit subject line with the affected package, if one can easily be chosen.
86
For example, the subject line of a commit mostly affecting the
87
`server/serverpb` package might read: "server/serverpb: made great again".
88
Commits which affect many packages as a result of a shared dependency change
89
should probably begin their subjects with the name of the shared dependency.
90
Finally, some commits may need to affect many packages in a way which does
91
not point to a specific package; those commits may begin with "*:" or "all:"
92
to indicate their reach.
94
+ Run the test suite locally:
95
96
`go generate ./pkg/... && make check test testrace`
97
98
+ When you’re ready for review, groom your work: each commit should pass tests
99
and contain a substantial (but not overwhelming) unit of work. You may also
100
want to `git fetch origin` and run
101
`git rebase -i --exec "make check test" origin/master` to make sure you're
102
submitting your changes on top of the newest version of our code. Next, push
104
107
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request). If you know of
108
another GitHub user particularly suited to reviewing your pull request, be
109
sure to mention them in the pull request body. If you possess the necessary
110
GitHub privileges, please also [assign them to the pull request using
111
GitHub's UI](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/).
114
+ If you get a test failure in CircleCI, check the Test Failure tab to see why
115
the test failed. When the failure is logged in `excerpt.txt`, you can find
116
the file from the Artifacts tab and see log messages. (You need to sign in to
119
+ Address feedback by amending your commits. If your change contains multiple
120
commits, address each piece of feedback by amending that commit to which the
121
particular feedback is aimed. Wait (or ask) for new feedback on those
122
commits if they are not straightforward. An `LGTM` ("looks good to me") by
123
someone qualified is usually posted when you're free to go ahead and merge.
124
Most new contributors aren't allowed to merge themselves; in that case, we'll
131
* the [net/trace](https://godoc.org/golang.org/x/net/trace) endpoint at
132
`/debug/requests`. It has a breakdown of the recent traced requests, in
133
particularly slow ones. Two families are traced: `node` and `coord`, the
134
former (and likely more interesting one) containing what happens inside of
135
`Node`/`Store`/`Replica` and the other inside of the coordinator
138
heap and cpu profiles; [this golang blog post](http://blog.golang.org/profiling-go-programs) explains it extremely well and
139
[this one by Dmitry Vuykov](https://software.intel.com/en-us/blogs/2014/05/10/debugging-performance-issues-in-go-programs)
146
make acceptance TESTS='TestPut$$' TESTFLAGS='-v -d 1200s -l .' TESTTIMEOUT=1210s
147
```
148