Thank you for considering making contributions to Fourth State's Plasma MVP implementation! We welcome contributions from anyone! See the open issues for things we need help with!
Contribute to design discussions and conversation by joining our Discord Server
Add this repository into your $GOPATH/src/github.com/FourthState directory:
go get "github.com/FourthState/plasma-mvp-sidechain"
Testing:
make test
Using go get on a forked repository will result in all the import paths being wrong. So instead we will add a new remote for the original repo.
To create a fork and remote branch to work on:
-
Create a fork on github
-
Go to the original repo locally (ie.
$GOPATH/src/github.com/FourthState/plasma-mvp-sidechain) -
git remote rename origin upstream -
git remote add origin git@github.com:user/plasma-mvp-sidechain.git
origin : refers to fork
upstream : refers to original repo
Now, create a branch that is named off the feature you are trying to implement. See these guidelines
Make your changes. Add tests and comment those changes.
If your tests pass, push to your fork and submit a pull request to the develop branch.
If you would like to propose a protocol change, open up an issue. If the reviewers decide the proposed change is in line with the project's aim, then a writeup should also be added to the research repository. It is also advisable to publish the proposed change to Eth Research, so other plasma implementations can benefit from the proposed change.