CONTRIBUTING.md

Contributing

Pre-requisites

This repo using git hooks to ensure that the code is committed in a good state. To install the hooks, run the following command:

git config core.hooksPath .githooks

Ensure the following are installed:

• Deno (we will eventually move to this dependency)
• Node.js

Set-up and testing

To get started, clone the repo and install the dependencies:

npm install

Then run the formatting, linting and tests:

npm run pre-commit

Development

It is useful to run the following in watch mode while developing

Compiling

npm run watch

Testing

npm run test:watch

Release Process

To release a new version, take the following steps:

• Bump the version by running the version_bump GitHub Action and choose the appropriate version bump:

• Wait for the Pull Request to be created and merge this into main.

• Wait for the main branch action to complete.

• Find the created draft release and publish it.