CONTRIBUTING.md

Contributing Guide

Your help is more than welcome, I would be very honored to have you on my side.

Here are some very basic guidelines.

Commits

Please follow these guidelines so your commits will be taken by the self-generated changelog.

Style

ESLint is set up on the project. It will be checked at build time.

We follow a 4 spaces rule around here.

Workflow

You can use the available scripts if needed.

• npm start will start the webpack server on localhost:9000 and build the library.
  • You can navigate examples if needed:
    • ./example/codepen-demo.html
    • ./example/dual-joysticks.html
    • ./example/lock-axes.html
• npm test will test using CasperJS, you have to run npm start in another window to have a local server available to CasperJS. You need to install CasperJS and PhantomJS globally for it to run npm install -g casperjs phantomjs