Contributing

This repository uses git-flow in the gitflow-avh edition to organize development.

Please raise your PRs against the develop branch (regardless of git-flow usage).

Before raising a PR, please make sure that

your code is lint-free (yarn lint),
your code compiles (yarn build),
the tests run through (yarn test). Also don't forget to comment your code properly and add code documentation / tests.

Thanks for contributing!

Best practices

Use git-flow to develop a feature or a fix branch
Please put your classes in ClassName.ts
If you're implementing something changelog-worthy, please add it to the upcoming changelog
Please don't use default exports (see this and this)
Bonus points: Make the methods/classes you add fun and easy to use 🎉