Contributing

tappy should be easy to contribute to. If anything is unclear about how to contribute, please submit an issue on GitHub so that we can fix it!

How

Fork tappy on GitHub and submit a Pull Request when you’re ready.

Setup

tappy uses Pipenv to manage development. The following instructions assume that Pipenv is installed. See the Pipenv install instructions for more details.

After installing Pipenv:

$ git clone git@github.com:python-tap/tappy.git
$ cd tappy
$ pipenv install --dev --ignore-pipfile
$ pipenv shell
$ # Edit some files and run the tests.
$ pytest

The commands above show how to get a tappy clone configured. If you’ve executed those commands and the test suite passes, you should be ready to develop.

Guidelines

  1. Code should follow PEP 8 style. Please run it through pep8 to check.
  2. Please try to conform with any conventions seen in the code for consistency.
  3. Make sure your change works against master! (Bonus points for unit tests.)