Contributing Code

  • A good patch:

    • is clear
    • works across all supported versions of Python
    • follows the existing style of the code base (PEP-8)
    • has docstrings (we use Goole style docstrings)
    • has comments included as needed
  • A test case that demonstrates the previous flaw that now passes with the included patch

  • If it adds/changes a public API, it must also include documentation for those changes

Reporting An Issue/Feature