Contributing

See CONTRIBUTING.md in the repository root for the full guide.

The short version:

pip install -e ".[dev]"   # install
python -m pytest          # tests
python -m mypy cowser     # type checks
mkdocs serve              # preview the docs

Releasing

1. Bump the version in cowser/__init__.py and pyproject.toml; add a CHANGELOG.md entry.
2. Publish manually: python -m build && python -m twine upload dist/*.

The only automated workflow is docs.yml, which rebuilds and deploys the docs site on every push to main.

---

← Back to README