Skip to content

Latest commit

 

History

History
13 lines (9 loc) · 833 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (9 loc) · 833 Bytes

Contributing

We would love to have our 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

  1. Set up your local environment by forking the repository.
  2. When you are about to commit, commitlint is running to check if your commit message respects conventional commit
  3. Write tests, there is a high coverage on the repository. Simply run npm run test:cov to generate a coverage/ directory.
  4. Respect coding style: We use eslint for coding guidelines. Run npm run lint to check if there are errors.
  5. Open a Pull Request where you describe the feature/issue you are about to publish.