/cockroach

Permalink
cockroach/CONTRIBUTING.md
Newer
Older
Raw Normal view History
100644 31 lines (20 sloc) 888 Bytes
@andybons
Create CONTRIBUTING.md
May 27, 2014
1
# Contributing to Cockroach
2
@andybons
Update CONTRIBUTING.md
Jun 3, 2014
3
### Getting and building
4
5
A working [Go environment](http://golang.org/doc/code.html) and [prerequisites for building
6
RocksDB](https://github.com/cockroachdb/rocksdb/blob/master/INSTALL.md) are both presumed.
7
```bash
Andrew Bonventre
No more Phabricator
Sep 7, 2014
8
mkdir -p $GOPATH/src/github.com/cockroachdb/
9
cd $GOPATH/src/github.com/cockroachdb/
10
git clone git@github.com:cockroachdb/cockroach.git
11
cd cockroach
@andybons
Update CONTRIBUTING.md
Jun 3, 2014
12
./bootstrap.sh
13
make
14
```
15
Andrew Bonventre
No more Phabricator
Sep 7, 2014
16
### Code review workflow
@andybons
Update CONTRIBUTING.md
Jun 3, 2014
17
Andrew Bonventre
No more Phabricator
Sep 7, 2014
18
+ Create a local branch to do work on.
@andybons
Update CONTRIBUTING.md
Jun 3, 2014
19
Andrew Bonventre
No more Phabricator
Sep 7, 2014
20
`git checkout -b andybons/update-readme`
@andybons
Create CONTRIBUTING.md
May 27, 2014
21
Andrew Bonventre
No more Phabricator
Sep 7, 2014
22
+ Hack away and commit your changes locally using `git add` and `git commit`.
@andybons
Create CONTRIBUTING.md
May 27, 2014
23
Andrew Bonventre
No more Phabricator
Sep 7, 2014
24
`git commit -a -m 'update CONTRIBUTING.md'`
@andybons
Create CONTRIBUTING.md
May 27, 2014
25
Andrew Bonventre
No more Phabricator
Sep 7, 2014
26
+ When you’re ready for review, create a remote branch from your local branch.
@andybons
Create CONTRIBUTING.md
May 27, 2014
27
Andrew Bonventre
No more Phabricator
Sep 7, 2014
28
`git push -u origin andybons/update-readme`
@andybons
Create CONTRIBUTING.md
May 27, 2014
29
Andrew Bonventre
No more Phabricator
Sep 7, 2014
30
+ Then [create a pull request using GitHub’s UI](https://help.github.com/articles/creating-a-pull-request).