Contributing

Development setup

git clone https://github.com/holgern/repairledger.git
cd repairledger
pip install -e ".[dev]"

Code style

This project uses ruff for linting and mypy for type checking.

python -m ruff check .
python -m mypy repairledger

Testing

python -m pytest -q

Building

python -m build --sdist --wheel
python -m twine check dist/*

Releasing

1. Update version via Git tag: git tag v0.2.0

2. Build: python -m build --sdist --wheel

3. Upload: python -m twine upload dist/*

Documentation

Documentation uses Sphinx with MyST Markdown support.

cd docs
python -m sphinx -b html . _build/html