de0281d Jun 4, 2016
251 lines (217 sloc) 8.97 KB

Contributing to Sia

Table of Contents

Get started with Go

Install Go

To install Go on your computer, follow the official installation guide.

You should install the latest official Go binary for your system (if not available, install from source). If you plan to cross compile Sia, see Cross Compilation with Go 1.5 by Dave Cheney.

Now make a workspace directory in which you will store source code and dependencies. You can choose any filepath except where you installed Go (don't choose /usr/local).

# make a working directory called golang in your home directory
$ mkdir $HOME/golang
# store base path in an environmental variable
$ echo 'export GOPATH=$HOME/golang' >> $HOME/.profile
# add bin subdirectory to PATH environmental variable
$ echo 'export PATH=$PATH:$GOPATH/bin' >> $HOME/.profile

Learn Go

Build Sia

To build Sia on your machine, enter the following on the command line:

# Download Sia and its dependencies
# Binaries will be installed in $GOPATH/bin
$ go get -u

# Switch to directory containing Sia source code
$ cd $GOPATH/src/

# You have three Sia builds to choose from.
# To build the standard release binary:
$ make release-std
# Or to build the release binary with race detection and an array debugging 
# asserts:
$ make release
# Or to build the developer binary (with a different genesis block, faster 
# block times, and other changes):
$ make

Contribute to the codebase

Set up git

Install git on your machine according to these instructions in the Pro Git book.

You will first need to set up global settings using the command line.

$ git config --global "Your Name"
$ git config --global

# Tell git to remember your login information for a certain amount of time.
# Default time is 15 minutes:
$ git config --global credential.helper cache
# Or you can choose a different amount of time:
$ git config --global credential.helper "cache --timeout=[seconds]"

Fork the Sia repository

While logged into your Github account, navigate to the Sia repository and click the 'Fork' button in the upper righthand corner. Your account now has a 'forked' copy of the original repo at<your GitHub username>/Sia.

When you installed Sia using go get, the go tool put the Sia source code in $GOPATH/src/ Change to that directory and set up your fork as a git remote:

$ cd $GOPATH/src/
# Add your fork as a remote.  Name it whatever is convenient,
# e.g your GitHub username
$ git remote add <remote name><username>/Sia.git

Write some code

Right now your git local repository only has one branch (called 'master' by default). If you want to make changes, add a new branch and make your changes there. You should maintain master as an up-to-date copy of the NebulousLabs/Sia repository's master branch.

To create and checkout a new branch:

# If you're not already in the right directory:
$ cd $GOPATH/src/NebulousLabs/Sia
# Make sure you're on branch master
$ git checkout master
# Create and checkout a new branch
$ git checkout -b <branch>

Now write some code while the new branch is checked out.

Only implement one logical change per branch. If you're working on several things at once, make multiple branches. To switch between branches you're working on, you have to stash the changes in the branch you're switching from by running git stash, which tucks away all changes since the last commit.

# Stash changes to current branch.
$ git stash
# Checkout other branch.
$ git checkout <branch>
# Make changes
# Return to first branch:
$ git checkout <branch 1>
# View a list of stashes and their corresponding hashes.
$ git stash list
# Reapply changes from the stash you want to recover and remove that stash from.
# the list
$ git stash pop <hash>

To learn more about branching, see Using the Fork-and-Branch Git Workflow and Pro Git - Branches in a Nutshell. For more on stashing, see Pro Git - Stashing and Cleaning.

Be sure to follow the conventions detailed in docs/ We will reject pull requests that do not satisfy these best practices.

Once you've finished making changes, stage and commit your changes then update your fork on Github:

# Make sure the code is up to date with the original repo:
$ git checkout master
$ git pull origin master
# Checkout branch with changes.
$ git checkout <branch>
$ git rebase master
# Before every pull request, you should run `make test-long`
# to test your code and fix formatting and style problems.
$ make test-long
# If all goes well, proceed to staging your changed files:
$ git add <changed files>
# Use `git status` to see what files have been staged.
$ git status
# Commit your changes. If you just run `commit`,  a text editor will pop up for 
# you to enter a description of your changes.
$ git commit -m "Add new tests for CommitSync method"
# Push the changes to your fork on GitHub, which you should have set up as a 
# remote already.
$ git push <fork remote> <branch>

Submit your code for review

Once you've tested your new code and pushed changes to your fork, navigate to your fork at<username>/Sia in your browser.
Switch to the branch you've made changes on by selecting it from the list on the upper left. Then click 'New pull request' on the upper right.

Once you have made the pull request, we will review your code. We will reject code that is unsafe, difficult to read, or otherwise violates the conventions outlined in docs/

Here's a sample code review comment: Screenshot

If you want to tweak code for which you've already submitted a pull request, push the updated code to your fork with git push -f <fork remote> <branch> and summarize the changes you've made in a comment on the pull request page on GitHub.

Once we have accepted your changes and merged them into the original repo, you have some cleanup to do:

# Update local master branch to reflect changes in origin (the original 
# repo).
$ git pull origin master
# Delete the branch you made the pull request from.
$ git branch -d <branch>
# Delete the remote branch on your fork.
$ git push <fork remote> :<branch>
# Update your fork.
$ git push <fork remote> master

More Git resources

Where to start

If you'd like to contribute to Sia but don't have any specific ideas, writing tests is a good way to get your feet wet. See doc/Running and Writing Tests for to get started.

Contact us

Feel free to ask for help on the #dev channel on Slack.