Please make sure to read and observe our Code of Conduct.
You can start by finding an existing issue with the good first issue or help wanted labels. These issues are well suited for new contributors.
Badger uses Go Modules
to manage dependencies. The version of Go should be 1.12 or above.
- Visit https://github.com/dgraph-io/badger
- Click the
Fork
button (top right) to create a fork of the repository
$ git clone https://github.com/$GITHUB_USER/badger
$ cd badger
$ git remote add upstream git@github.com:dgraph-io/badger.git
# Never push to the upstream master
git remote set-url --push upstream no_push
Get your local master up to date:
$ git fetch upstream
$ git checkout master
$ git rebase upstream/master
Create a new branch from the master:
$ git checkout -b my_new_feature
And now you can finally add your changes to project.
Build and run all tests:
$ ./test.sh
Commit your changes:
$ git commit
When the changes are ready to review:
$ git push origin my_new_feature
Just open https://github.com/$GITHUB_USER/badger/pull/new/my_new_feature
and
fill the PR description.
Click the Sign in with Github to agree button to sign the CLA. An example.
If your pull request (PR) is opened, it will be assigned to one or more reviewers. Those reviewers will do a code review.
To address review comments, you should commit the changes to the same branch of the PR on your fork.