Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.03 KB

Contributing

First of all, thank you for contributing, you are awesome!

Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.

You MUST follow the TypeScript standards. If you don't know about any of them, you should really read the recommendations.

You MUST run the npm run coverage command.

You MUST write (or update) unit tests.

You MUST run the npm run commit hook to add a new commit.

You SHOULD write documentation.

Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.

One may ask you to squash your commits too. This is used to "clean" your Pull Request before merging it (we don't want commits such as fix tests, fix 2, fix 3, etc.).

Thank you!