Skip to content

Commit

Permalink
Merge pull request #30 from FourthState/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
colin-axner committed May 28, 2018
2 parents 6849c31 + fcdff87 commit c50d65e
Show file tree
Hide file tree
Showing 23 changed files with 2,141 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
vendor/
22 changes: 22 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
language: go

go:
- "1.10.x"

env:
- DEP_VERSION="0.4.1"

before_install:
# Download the binary to bin folder in $GOPATH
- curl -L -s https://github.com/golang/dep/releases/download/v${DEP_VERSION}/dep-linux-amd64 -o $GOPATH/bin/dep
# Make the binary executable
- chmod +x $GOPATH/bin/dep

install:
- dep ensure

script:
- go test -race -coverprofile=coverage.txt -covermode=atomic -v ./...

after_success:
- bash <(curl -s https://codecov.io/bash)
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing

Thank you for considering making contributions to Fourth State's Plasma MVP implementation! We welcome contributions from anyone! See the [open issues](https://github.com/FourthState/plasma-mvp-sidechain/issues) for things we need help with!

Contribute to design discussions and conversation by joining the #plasma-dev channel on Blockchain @ Berkeley's [public slack](https://www.berkeleyblockchain.slack.com/).

## Prerequisites
* [Golang](https://golang.org/doc/install)

* [dep](https://github.com/golang/dep)

## How to get started:

Add this repository into your $GOPATH/src/github.com/FourthState directory:

`go get "github.com/FourthState/plasma-mvp-sidechain"`

To get dependencies:

`dep ensure`

### Forking

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 [email protected]: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](https://nvie.com/posts/a-successful-git-branching-model/)

Make your changes. Add tests and comment those changes.

If your tests pass, push to your fork and [submit a pull request](https://github.com/FourthState/plasma-mvp-rootchain/pulls) to the develop branch.


## Proposals:

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](https://github.com/FourthState/plasma-research). It is also advisable to publish the proposed change to [Eth Research](https://ethresear.ch/), so other plasma implementations can benefit from the proposed change.

287 changes: 287 additions & 0 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c50d65e

Please sign in to comment.