Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,16 @@ Base workspace can run the same checks with the project’s standard Python
tooling:

```bash
python3 -m pip install -e ".[dev,typer,quality]"
python3 -m pytest
ruff format --check scripts examples
ruff check lib/python/base_cli scripts examples tests
python3 -m mypy --strict examples/typed_consumer.py
python3 scripts/validate_docs.py
python3 -m compileall -q examples
python3 -m build
python3 -m pip install -e ".[dev,typer,quality,benchmark]"
./tests/full_validate.sh
```

Use the Python interpreter from your active virtual environment in place of
`python3` when necessary. The strict mypy command covers the supported typed
consumer fixture; the framework-wide typing gate is tracked separately.
`python3` when necessary. The aggregate is the authoritative local gate and
includes the framework-wide strict typing, documentation, benchmark, package,
and security checks. Use `./tests/validate.sh` for the fast repository-baseline
check when the full extras are not installed; it is not a substitute for the
aggregate.

## Workflow

Expand Down
7 changes: 4 additions & 3 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ and install the reviewed wheel in an isolated environment. The installed-wheel
smoke test exercises public API, lifecycle, and output behavior without the
source tree on `sys.path`. Tests run across Python 3.10 through 3.14 on Linux,
macOS, and Windows, with Debian, Fedora, and WSL validation retained. Blocking
quality gates cover Ruff formatting/lint, strict public-sample typing, an 80%
branch-coverage threshold, documentation/example checks, and dependency/static
security scans. The [performance contract](performance.md) also checks fresh
quality gates cover Ruff formatting/lint, strict public-sample and
framework-wide typing, and an 80% combined statement-and-branch coverage
threshold. Documentation/example checks and dependency/static security scans
are separate required gates. The [performance contract](performance.md) also checks fresh
import and isolated invocation budgets, while the adversarial suite exercises
redaction, protocol framing, persistence, concurrency, retention, and signal
cleanup.
Expand Down
Loading