Contributing to PyStator¶
Thank you for your interest in contributing. This page is the documentation hub for contributors; the canonical dev guide with branch flow, Ruff/mypy, UI, and commit conventions lives in the repository root.
Quick links¶
| Resource | Description |
|---|---|
| CONTRIBUTING.md (repo root) | Dev setup, tests, lint, UI, Conventional Commits, release branches |
| Publishing to PyPI | Tags, Trusted Publishing, publish.yml |
| Release workflow | Day-of-release checklist and verification |
| Code of Conduct | Community standards |
| Security | Responsible disclosure |
Development setup (summary)¶
git clone https://github.com/optophi/pystator.git
cd pystator
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -U pip
pip install -e ".[dev]"
pytest
Use Ruff for format/lint and mypy on src/pystator as described in CONTRIBUTING.md. Prefer python -m pre_commit install (and pre-push) so CI stays green.
Documentation¶
This site is built with MkDocs and mkdocstrings. From the repo root, with [dev] installed:
See CONTRIBUTING.md for details on bundled docs and DOCS_ROOT.