CONTRIBUTING.md

Contributing

Thank you for taking the time to contribute! Guidelines below are meant to help you along the way. All contributions are welcome, including ideas, tweaks and more.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Proposing a change

Before making a non-trivial change, please discuss it via issues. You should begin the title with [useHookName] if applicable.

Development process

Please keep the scope of each pull request to one specific feature or fix.

Prequisites

• Node.js >=10.13
• Yarn >=1

Workflow

0. Assign related issues to yourself

1. Clone a fork of the master branch and install all the required dependencies with yarn

2. Make changes to the codebase

3. Before pushing, fix any errors possibly emitted by the following commands:

   • yarn format fixes stylistic issues using Prettier
   • yarn lint enforces coding rules based on the Airbnb JavaScript Style Guide
   • yarn test runs tests found in '*.test.ts(x)' files

4. If you made documentation changes, then update documentation.yml and run yarn doc

5. Record your changes with yarn commit, adhering to the Conventional Commits specification

6. Open a new pull request, referencing corresponding issues if available

License

As a collaborator, you agree to license your contributions under the project's MIT license.