Contributing to `auto-changelog`

Installing the library locally is relatively easy:

git clone https://github.com/CookPete/auto-changelog.git
cd auto-changelog
yarn # or npm install

You can then run it with simply:

node src/index.js

Linting

This project uses standard code style. Be sure to lint the code after making changes and fix any issues that come up.

yarn lint # or npm run lint

This project uses mocha and chai for testing. Be sure to run tests after making changes and, if you’re feeling generous, add some tests of your own.

yarn test # or npm test

A great way to show your appreciation and get an issue bumped to a higher priority is to become a sponsor on Patreon.