Skip to content

Contributing

Andrew McPherson edited this page Mar 5, 2016 · 4 revisions

Contributing Guide

Fork It

Before you can begin contributing, you need to fork of this repository.

Read more at: Forking

Build It

Run npm install and node build server to build the game from source.

Read more at: Building

Code It

Our stack is built on Javascript, using React. We support the latest specs for ECMAscript 2015, using Babel to transpile our code for older browsers. For reference, check out our Cookbook.

Test It

We run our tests in the browser. We use Expect

Lint It

We have a Styleguide, but it isn't anything too complicated. When building, your code is linted.

Share It

Push your code to Github-Pages. Check out "./share.sh" to see what it'll take. Try to name your share after the pull request number.

Get Code Reviewed

Don't merge your own code; let others merge your code after they give you a code review. Be sure to list any issues you're addressing with your code. Consult our checklist for what we consider in a code review.

Get Merged

After your code has been thoroughly reviewed, one of your peers will merge your code. Congratulations!! As a rule, you are not allowed to merge your own code, so you'll need to bother somebody else until they do it.

Clone this wiki locally