# Contributing Guidelines

## Here's your chance to enter our commit history

First off, thank you for considering contributing to this project.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. See our [Code of Conduct](CODE_OF_CONDUCT.md).


## What we are looking for _(Spoiler alert: ANYTHING)_

We love to receive contributions from the community! There are many ways to contribute, from improving the documentation or the tests, submitting bug reports and feature requests or simply writing code.

**Please, before investing a lot of time, check with us if it's something we're interested in, just so we don't have to reject something you worked hard on...**


## How to submit a contribution

1. Create your own fork of the code
2. Do the changes in your fork
3. If you like the change and think the project could use it:
    * Please **do not change anything** pertaining to the versioning *(We'll take care of that)*.
    * Please **do not update** any dependencies not pertaining to your changes *(We'll take care of that)*.
    * Be sure you have followed the code style for the project.
    * Be sure you have adjusted the tests accordingly.
    * Be sure you have adjusted the documentation accordingly.


## How to report a bug

### Security vulnerability
If you find a security vulnerability, please follow the instructions from our [Security Policy](SECURITY.md).

### Anything else
Open a 'Bug report' issue.


## How to suggest a feature or enhancement
Open a 'Feature request' issue.


## Be patient
We read and respond to all of our fan mail, but not on a daily basis. _(Sometimes WORK gets in the way...)_