CONTRIBUTING.md

Contributing

Feel free to submit any new features via Pull Request. Make sure the supplied tests still work and to add own test cases to cover your code.

PNPM

This repository uses pnpm instead of npm for installing NPM packages. Install it using npm i -g pnpm if you haven't already. All commands from npm are available with pnpm.

Install dependencies with pnpm install.

Commit message hook

This project uses Commizen for consistent commit message formatting.

Please run the following command to setup the Commitizen commit message hook:

echo '#!/bin/bash
exec < /dev/tty && node_modules/.bin/git-cz --hook || true' > .git/hooks/prepare-commit-msg && chmod +x .git/hooks/prepare-commit-msg

Running tests

Run tests by this command:

pnpm run test