Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Fixes #141
  • Loading branch information
cookpete committed Jun 13, 2020
1 parent 7b8c1a2 commit bc441f1
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to `auto-changelog`

Installing the library locally is relatively easy:

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

You can then run it with simply:

```bash
node src/index.js
```

## Linting

This project uses [standard](https://github.com/feross/standard) code style. Be sure to lint the code after making changes and fix any issues that come up.

```bash
yarn lint # or npm run lint
```

## Testing

This project uses [mocha](https://github.com/mochajs/mocha) and [chai](https://github.com/chaijs/chai) for testing. Be sure to run tests after making changes and, if you’re feeling generous, add some tests of your own.

```bash
yarn test # or npm test
```

## Becoming a sponsor

A great way to show your appreciation and get an issue bumped to a higher priority is to [become a sponsor on Patreon](https://www.patreon.com/cookpete).

0 comments on commit bc441f1

Please sign in to comment.