Contributing

Prerequisites

If you are not already familiar with Poetry, this is a poetry project, so you’ll need this!

Getting Setup

Note, while the project itself provisionally runs on python 3.6, test dependencies including pytest-mock-resources, coverage, and black, have minimum python versions of 3.7. So local development of pytest-alembic itself requires. Additionally this means we dont test 3.6 support, so supporting it is best effort until it becomes inconvenient.

See the Makefile for common commands, but for some basic setup:

# Installs the package with all the extras
make install

And you’ll want to make sure you can run the tests and linters successfully:

# Runs CI-level tests, with coverage reports
make test lint

Need help

Submit an issue!