CONTRIBUTING.org

Overview

This project uses a linear history workflow, i.e., rebase instead of merge.

Style Guide

This project uses the Airbnb style guide. Refer to: https://github.com/airbnb/javascript.

Definitions

TERM	REPO
Upstream	stoneandsand/stoneandsand
Origin	your github/stoneandsand
Local	Local files in git.

Workflow

1. Update the local master branch.

git checkout master
git pull --rebase upstream master

2. Create a new feature-branch, or check out an existing one.

git checkout -b feature-branch-name

3. Edit your code, commit and pull from upstream/master regularly.

git status
git add
git commit

4. Make sure you are still up-to-date with master before pushing.

git pull --rebase upstream master

5. Push your branch to github.

git push origin feature-branch

6. Make a pull request on github.

Rejected

If your pull request was rejected, return to step 3.

Merged

Update your local master branch, then your github master branch.

git checkout master
git pull --rebase upstream master
git push origin master -f