Skip to content

Contributor Guide

Jump to bottom
Zhijie Shen edited this page Oct 17, 2019 · 1 revision

Submitting Pull Request

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review.

For the first time setup,

  1. Fork iotex-core into your own account.
  2. Execute the following instructions:
$ git clone git@github.com:iotexproject/iotex-core.git
$ cd iotex-core
$ git remote add fork git@github.com:<your_account>/iotex-core.git

Once you have the code repo properly setup, you could code, test and then commit a change locally. Then, push the change to your fork repo via the following command.

$ git push fork master

Finally, create pull request from your fork repo. In general commits should be atomic and diffs should be easy to read, and the coding conventions must be adhered to.

Patch tags

In some cases, your commit may bring big changes to the code base. It is better to tag out in your commit.

dependency update: include this tag when you introduce a new dependency or update existing dependencies.

breaking change: include this tag, if you are making a breaking change on protocal, client API or storage API.

Clone this wiki locally