Contributing

When writing code, you MUST ALWAYS follow the naming-things guidelines.

Design Principles

Durability – We recover from any failures, even poorly written tasks.
Consistency – We never lose data, even if someone unplugs the power or network.
Utilization – We keep the CPU saturated with tasks, not with idle time or waiting for locks.

We have unit tests, integration tests, and benchmarks. Avoid mocking if possible.

To run the tests, use the following command:

uv run pytest

To run only integration tests:

uv run pytest -m integration

To run only integration benchmarks:

uv run pytest -m "integration and benchmark"

Benchmarking snapshots are created automatically. To compare your feature branch against the main branch, run the test suite on main, followed by:

uv run pytest --benchmark-compare

Before your first commit, ensure that the pre-commit hooks are installed by running:

uvx prek install