- A working GCC (on mac os x something like
xcode-select --installwill get you started) - Go environment
- prerequisites for building RocksDB
- protoc
- pkgconfig
- curl
If you're on Mac OS X, homebrew can be very helpful to fulfill these dependencies.
mkdir -p $GOPATH/src/github.com/cockroachdb/
cd $GOPATH/src/github.com/cockroachdb/
git clone [email protected]:cockroachdb/cockroach.git
cd cockroach
./bootstrap.sh
make- Create a local feature branch to do work on, ideally on one thing at a time. If you are working on your own fork, see this tip on forking in Go, which ensures that Go import paths will be correct.
git checkout -b andybons/update-readme
- Hack away and commit your changes locally using
git addandgit commit.
git commit -a -m 'update CONTRIBUTING.md'
- When you’re ready for review, create a remote branch from your local branch. You may want to
git fetch originand rungit rebase origin/masteron your local feature branch before.
git push -u origin andybons/update-readme
-
Address feedback in new commits. Wait (or ask) for new feedback on those commits if they are not straightforward.
-
Once ready to land your change, squash your commits. Where n is the number of commits in your branch, run
git rebase -i HEAD~n
and subsequently update your remote (you will have to force the push, git push -f andybons mybranch). The pull request will update.
- If you do not have write access to the repository and your pull request requires a manual merge, you may be asked to rebase again,
git fetch origin; git rebase -i origin/masterand update the PR again. Otherwise, you are free to merge your branch into origin/master directly or rebase first as you deem appropriate.