Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 947 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 947 Bytes
Raw

How to contribute

Install dependencies

npm install

Codestyle

A .prettierrc file is available to maintain the coding style. Besides, your code will automatically be formatted by the pre-commit hook.

Unit tests

Run the unittest using the below command:

npm test

Before submitting

Before submitting your Pull Request, please do the following steps:

  1. Add any changes you want.
  2. Add tests for the new changes.
  3. Edit documentation (README.md) if you have changed something significant.
  4. Commit your changes using Conventional Commits.
    Examples: feat: add JSON parser, feat(parser): add JSON parser.

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.