Skip to content

Contributing

taskiq-sqs follows the same contribution philosophy as the rest of the taskiq ecosystem — see the taskiq contribution guide for the general rules (found a bug? open an issue; not sure about something? open a draft PR and ask in the description; and so on).

The commands below are specific to this repository — it uses uv and zensical rather than the tox/VuePress setup described on that page.

Setting up the environment

git clone https://github.com/taskiq-python/taskiq-sqs.git
cd taskiq-sqs
make init

Tests need a local AWS emulator (ministack):

make run_infra

Linting and testing

make lint   # ruff + mypy
make test   # pytest, against the ministack container started above

make help lists every available target.

Working with documentation

This site is built with zensical. To preview changes locally:

make run_docs