Permalink
May 27, 2014
May 27, 2014
Newer
100644
57 lines (38 sloc)
1.61 KB
1
# Contributing to Cockroach
2
5
We use [Phabricator](http://phabricator.andybons.com/) for code reviews. Phabricator
6
uses your GitHub credentials, just click on the "Login or Register" button. The Phabricator
7
development model is similar to the GitHub pull request model in that changes are
8
typically developed on their own branch and then uploaded for review. When a change is
9
uploaded to Phabricator (via `arc diff`), it is not merged with master until
10
the review is complete and submitted.
11
12
+ Hack away...
13
+ Commit your changes locally using `git add` and `git commit`.
14
+ Upload your change for review using `arc diff`.
15
16
## Installing Arcanist
17
To install Arcanist (the code review tool)...
18
19
Create a dir that will hold the two repos required.
20
21
`$ mkdir somewhere`
22
23
then clone the required repos into that folder:
24
25
```
26
somewhere/ $ git clone git://github.com/facebook/libphutil.git
27
somewhere/ $ git clone git://github.com/facebook/arcanist.git
28
```
29
30
Then add somewhere/arcanist/bin/ to your $PATH
31
32
Now within the cockroach directory...
33
34
```
35
$ git checkout -b newbranch
36
... make changes ...
37
$ git commit -a -m 'my awesome changes'
38
$ arc diff
39
```
40
41
Say you’ve updated your diff to account for some suggestions, you just commit those on the same branch and do:
42
43
```
44
$ arc diff
45
```
46
47
again and it will take care of uploading things.
48
49
Once you’re ready to land a change (it has been approved).
50
51
```
52
$ arc land
53
```
54
55
it will squash all commits, update the commit message with the original headline and description, and have a link back to the review. It will also clean up (delete) your feature branch.
56