Contributing

Contributing to Commit Utils

Optionally install nvm to ensure you're using the correct version of node. You can find the node version in the

.nvmrc

file. Once you have the right version of node selected, you'll want to enable corepack via

corepack enable

Install dependencies.

yarn

This project uses Typescript and Yarn Berry.

TypeScript is linted with ESLint.

To run ESLint:

yarn lint
yarn lint:fix

You can execute

yarn build

to generate the build assets that ultimately gets uploaded to the NPM registry. It will also leave the intermediate

lib

artifacts, which contain the transpiled code.