Contributing Handbook

So you want to contribute to the project? How lovely! Here are a few things to keep in mind when working with the project:

Linting

jshint is used for style management. Make sure that your IDE recognizes the project's linting config before you start developing.

Testing

This project is using jest for testing and the test specifications should be placed within the /test folder. All functionality should have it's use-cases somewhat thoroughly tested (best sentence ever, thank you very much).

Coverage threshold

"branches": 50,
"functions": 50,
"lines": 50,
"statements": 50

Pull Requests

When you are done with your contribution, issue a pull request. The project maintainers will have a look at it as soon as possible!

Have fun

🎺 This is the most important thing of all.