# Contributing

Thanks for helping us make Bitmapist work better.

Please feel free to [report any issue](https://github.com/Doist/bitmapist/issues/new/choose) you may have.

**Working on your first Pull Request?** You can learn how from this _free_
series [How to Contribute to an Open Source Project on GitHub][egghead]

If you want to contribute with code, please open a Pull Request. A few things to keep in mind:

- The BSD project is released under the [BSD license](./LICENSE)
- Please use [pre-commit](https://pre-commit.com/) to ensure some formatting rules and basic consistency checks are applied before each Git commit
- Please add tests for your changes!
- Please document any changes using the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention
  - Changes in a PR should be documented under an `[Unreleased]` version
  - We'll bump the version number and update the changelog in a separate PR when publishing