CONTRIBUTING

# Contributing

All contributions are welcome and greatly appreciated!

## Steps to Contribute

> [!WARNING]
>
> Check the `engine` property in [`package.json`](./package.json) to see what
> version of Node.js is required for local development. This can be different
> from the version of Node.js used on the GitHub Actions runners. Tools like
> [nodenv](https://github.com/nodenv/nodenv) can be used to manage your Node.js
> version automatically.

1. Fork this repository
1. Commit your changes
1. Test your changes
1. Make sure to run `npm run all` before committing your final changes!
1. Open a pull request back to this repository
1. Notify the maintainers of this repository for peer review and approval
1. Merge :tada:

The maintainers of this repository will create a new release with your changes
so that everyone can use the new release and enjoy the awesome features of
branch deployments!

## Testing

This project requires **100%** test coverage.

> [!IMPORTANT]
>
> It is critical that we have 100% test coverage to ensure that we are not
> introducing any regressions. All changes will be throughly tested by
> maintainers of this repository before a new release is created.

### Running the Test Suite

Simply run the following command to execute the entire test suite:

```bash
npm run test
```

> [!NOTE]
>
> This requires that you have already run `npm install`