# Contributing

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/foundernest/namecase/pulls).

## Pull Requests

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Try to cover everything** - Ensure that you got all your new code covered or, if you can't, try to explain why on your pull request.

- **Update the changelog** - Make sure the `CHANGELOG.md` is up-to-date. Follow the example and good practices in the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) site. If you change some main behavior, be sure to also update the `README.md` file.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

## Running Tests

``` bash
yarn test:coverage
```

**Thank you and happy coding!**