# Contributing

## Creating your changes

1. Fork, then clone the repo:

        `git clone git@github.com:your-username/barrelsby.git`

2. Install dependencies:

        `npm install`

3. Make your changes.

4. Make sure the tests pass:

        `npm test`

5. Push to your fork and [submit a pull request][pullrequest].

[pullrequest]: https://github.com/bencoveney/barrelsby/compare/

## Requirements

All new code should:
* Pass CI checks (tslint, unit tests).
* Include unit tests for any changed code.
* Include relevant updates to `README.md`.
* Be consistent with the existing coding style.

## Issues

It is a good idea (however not strictly required) to create an issue to
discuss changes before making them.

Anyone is welcome to work on any issue marked *help wanted*.