Contributing

Preparation

You’ll need to have Python 3.6 available for testing. I recommend using pyenv for this:

$ pyenv install 3.6.5
$ pyenv shell 3.6.5

Setup

Create a fresh development enviroment, and install the appropriate tools and dependencies:

$ cd <path/to/attribution>
$ make venv
$ source .venv/bin/activate

Submitting

Before submitting a pull request, please ensure that you have done the following:

  • Documented changes or features in README.md

  • Added appropriate license headers to new files

  • Written or modified tests for new functionality

  • Used make format to format code appropriately

  • Validated and tested code with make lint test