Contributing

We would love to have your contribute, thank you for that! 🎉

If you want to add missing APIs, or correct an issue, you will have to follow this list of instructions.

Instructions

Set up your local environment by forking the repository.
When you are about to commit, commitlint is running to check if your commit message respects conventional commit.
Write tests, there is a high coverage on the repository. Simply run npm run cover to generate a coverage/ directory.
Respect coding style. Run npm run lint to check if there are errors.
Open a Pull Request where you describe the feature/issue you are about to publish.

Code Style

This project uses ESLint to analyze the TypeScript code. Commit are linted too thanks to commitlint and the conventional commit format.