CONTRIBUTING.md

Contributing

Contributions are greatly appreciated.

PR conventions

The project uses semantic-release, meaning that a new release will be published whenever functional changes are pushed to the master branch.

PR titles must follow the Conventional Commits Spec, e.g. fix: some fix (for a patch version release) or feat: some feature (for a minor version release).

CI Validations

PRs need to pass the following checks before they can be merged:

npm run check # Validates types.
npm run lint  # Validates code style.
npm run test  # Validates functionality.

If you have linting errors, you may be able to fix them automatically using:

npm run fix