Skip to content

Latest commit

 

History

History
169 lines (123 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

169 lines (123 loc) · 3.36 KB
Raw

Contributing guide

Development environment

  • Step 0. Setup Golang dev environment

Mysterium Network Node is written in Golang, if you want to hack on it you will need a functional go dev environment. See official golang documentation for how to https://golang.org/doc/install

  • Step 1. Get project dependencies

Install openvpn

# OS X using brew
brew install openvpn

# Ubuntu
sudo apt-get install openvpn
  • Step 2. Get the Mysterium-Node repository

One way to manage your repositories is to fork the mysteriumnetwork/node repository to your GitHub account then clone your newly forked repository (replace USER with your github username).

cd $GOPATH/src/github.com
mkdir mysteriumnetwork
cd mysteriumnetwork
git clone https://github.com/USER/node

This creates a remote called origin. To keep your fork in sync with upstream development add a remote called upstream

cd node
git remote add upstream https://github.com/mysteriumnetwork/node.git

For bonus points add a git alias and a shell alias to do the syncing. Edit `~/.gitconfig and add

[alias]
	pu = !"git fetch origin -v; git fetch upstream -v; git merge upstream/master"

Then define a shell alias

alias sync-repo='git pu; git push

Now any time you are on master branch (for any project you set up like this) you can run sync-repo to sync your fork with the upstream repository.

  • Step 3. Build

Run make help to get a list of build targets (you may like to run make dep and make dep-ensure to install dep and to get dependencies). Happy hacking!

Running

# Start node in provider role
bin/build && bin/run_provider

# Start node in consumer role
bin/build && bin/run_consumer

Running Node as interactive demo:

# Start node in CLI demo mode:
bin/run_consumer cli

# Show commands
» help
[INFO] Mysterium CLI tequilapi commands:
  connect
  identities
  ├── new
  ├── list
  status
  proposals
  ip
  disconnect
  help
  quit
  stop
  unlock

# Create a customer identity
» identities new

# Unlock a customer identity
» unlock <identity>

# Show provider identities
» proposals

# Connect to a server
» connect <consumer-identity> <provider-identity>

Generate Tequila API documentation from client source code

  • Step 1. Install go-swagger
brew tap go-swagger/go-swagger
brew install go-swagger
  • Step 2. Generate specification and serve serve it locally:
bin/swagger_serve_doc

Dependency management

  • Install project's frozen packages
dep ensure
  • Add new package to project
dep ensure -add github.com/ccding/go-stun
dep ensure -add github.com/ccding/go-stun@^0.1.0
  • Update package in project
vim Gopkg.toml
dep ensure -update

Creating pull request

To contribute a code, first you must create a pull request (PR). If your changes will be accepted this PR will be merged into main branch.

Before creating PR be sure to:

  • Step 1. Ensure that your code quality is passing
bin/check
  • Step 2. Ensure that all unit tests pass
bin/test
  • Step 3. Ensure that all end-to-end tests pass
bin/test_e2e

After you forked a project, modified sources and run tests, you can create a pull request using this procedure:

https://help.github.com/articles/creating-a-pull-request-from-a-fork/