Contributing

How to submit feedback?

The best way to send feedback is to file an issue.

If you are reporting a bug, please include:

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Ready to contribute? Here are the steps required to setup funky for local development.

Clone your fork locally:

$ git clone git@github.com:your_name_here/funky.git

Install your local copy of funky and all of funky's Python development dependencies into a virtualenv. Assuming you have virtualenvwrapper installed, the following commands should do the trick:
```
$ cd funky/
$ mkvirtualenv funky
$ python setup.py develop
$ pip install -r dev-requirements.txt
```
Install system development dependencies (e.g. shunit2):
```
$ ./scripts/install-system-dev-deps
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you're done making changes, check that all the tests are still passing::
```
$ make test
```
Additionally, any code added / changed is expected to pass all linting checks.
```
$ make lint
```

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

A reminder for the maintainers on how to deploy. Make sure all your changes are committed and that you have bumpversion installed. Then run:

$ bumpversion patch  # possible values: major / minor / patch
$ git push
$ git push --tags

A new version of funky will then deploy to PyPI if tests pass.