If you think there's room for improvement or see it broken feel free to submit a patch. We'll accept a patch through any medium: GitHub pull requests, gists, emails, gitter.im snippets, etc.
Your patch should adhere to these guidelines:
- The coding style is similar.
- All tests should pass
npm test
and coverage should remain at 100%npm run coverage
. - No linting errors are present
npm run lint
. - The commit history is clean (no merge commits).
- We thank you for your patch.
Fork the project and clone it to your computer. Then you'll need npm to install the project's dependencies. Just run:
npm install
To make sure everything is ok you should run the tests:
npm test
We use EditorConfig for basics and encourage you to install its plugin on your text editor of choice. This will get you 25% of the way there.
The only hard-line rule is that the code should look uniform. We loosely follow the Airbnb JS style guide with a few notable exceptions.
- You shouldn't have to use semicolons. The build file adds them in anyway.
- Do not rely on any ES6 shim/sham features (Map, WeakMap, Proxy, etc).
- Use
//
for comments. And comment anything you feel isn't obvious.
All of our code and files are licensed under MIT.