Contributing

Setting up a development environment

Install uv and run:

uv sync

uv run ruff check .
uv run ruff format --check .
uv run coverage run && uv run coverage report

coverage xml && coverage html are configured to output reports in the build directory.

To contribute to flatdict, please make sure that any new features or changes to existing functionality include test coverage.

Pull requests that add or change code without coverage have a much lower chance of being accepted.

Pull requests that fail ruff checks as configured will not be accepted.

Please format your code using ruff prior to issuing your pull request.

flatdict subscribes to semver style versioning.

Given a version number MAJOR.MINOR.PATCH increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.