How to Contribute

Helpful things

We're open source! We love contributions! An ordered list of helpful things:

GitHub issues can be treated like a massive, communal todo list. If you notice something wrong, toss an issue in and we'll get to it!

The following things are helpful
- js console or node logs
The following things should always be included
- the steps it would take to reproduce the issue
- what happened when you followed those steps
- what you expected to happen that didn't

Please follow linter warnings.
Optionally, add tests, we'd like to hit 100% code coverage.
We're using commitizen, so run git cz or npm run commit instead of usual commits for this repo.
Please write meaningful commit messages. Keep them somewhat short and meaningful. Commit messages like “meh”, “fix”, “lol” and so on are useless. Your are writing to your future self and everyone else. It’s important to be able to tell what a commit is all about from its message.

“Write every commit message like the next person who reads it is an axe-wielding maniac who knows where you live”
Thank you for contributing!

For initializing just run:

npm install

If you'll run only tasks from package.json you'll need no global dependency for developing this project.

To build project run:

npm run build

or for watching:

npm run watch

To test project run:

npm test

watching tests will be added later.