Before contributing to this repository make sure to discuss first the intended changes either by creating a new issue or commenting an existing one.

Useful commands

Once the repository has been cloned you can run the following commands from the root directory.

$ yarn install       # install project dependencies
$ yarn lint          # run linting against project code
$ yarn test          # run test

Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

Review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. Also make sure to reference the related issues in the pull request message, if any.

Release

Releases are automatically created via GitHub Actions when a new tag is pushed to the repository.