Goal
align contributor and release checks with the authoritative gate.
Background and evidence
Release-preparation review of 7d8e7d7e902ace88495c5e0ff3b9db4f4a7bf5d2 on macOS arm64. Python 3.13.15, Click 8.5.0, Typer 0.27.2.
The contributor entry point and release guide no longer describe the checks actually enforced:
CONTRIBUTING.md installs .[dev,typer,quality] and lists a hand-maintained subset of checks, omitting the benchmark extra and authoritative aggregate. It explicitly says framework-wide typing is tracked separately, but tests/full_validate.sh --gate typing now runs strict mypy over the entire package.docs/releasing.md describes an "80% branch-coverage threshold". --cov-fail-under=80 and validate_coverage.py use coverage.py's combined statement/branch percent_covered, not branch coverage alone.docs/testing.md already documents the correct aggregate and benchmark extra, so the newcomer path disagrees with the dedicated testing guide.
Current local evidence: the full source test run passes 593 tests and 250 subtests, strict framework mypy runs successfully, and the aggregate reports 87.24% combined coverage. No runtime behavior change is needed for this documentation correction.
Scope and acceptance criteria
- Make CONTRIBUTING lead with or link directly to the supported
.[dev,typer,quality,benchmark] setup and ./tests/full_validate.sh command.
- Correct the statement that framework typing is deferred.
- Name combined coverage accurately and distinguish platform/module floors from branch-only coverage.
- Keep optional Base shortcuts and fast baseline checks clearly scoped.
Validation
Run documentation validation and manually follow the documented setup/gate selection in a fresh environment.
Source references:
Non-goals
No release publication or unrelated API redesign. Preserve documented compatibility except for the defective behavior identified above.
Project fields
- Project:
base-cli
- Status:
Ready
- Priority:
P3
- Area:
Docs
- Initiative:
v1.0 Readiness
- Size:
S
- Milestone:
v1.0.0
Agent assignment
Assignee: @codeforester. Implementation may be handled through the normal issue-backed worktree and reviewed PR workflow.
Goal
align contributor and release checks with the authoritative gate.
Background and evidence
Release-preparation review of
7d8e7d7e902ace88495c5e0ff3b9db4f4a7bf5d2on macOS arm64. Python 3.13.15, Click 8.5.0, Typer 0.27.2.The contributor entry point and release guide no longer describe the checks actually enforced:
CONTRIBUTING.mdinstalls.[dev,typer,quality]and lists a hand-maintained subset of checks, omitting the benchmark extra and authoritative aggregate. It explicitly says framework-wide typing is tracked separately, buttests/full_validate.sh --gate typingnow runs strict mypy over the entire package.docs/releasing.mddescribes an "80% branch-coverage threshold".--cov-fail-under=80andvalidate_coverage.pyuse coverage.py's combined statement/branchpercent_covered, not branch coverage alone.docs/testing.mdalready documents the correct aggregate and benchmark extra, so the newcomer path disagrees with the dedicated testing guide.Current local evidence: the full source test run passes 593 tests and 250 subtests, strict framework mypy runs successfully, and the aggregate reports 87.24% combined coverage. No runtime behavior change is needed for this documentation correction.
Scope and acceptance criteria
.[dev,typer,quality,benchmark]setup and./tests/full_validate.shcommand.Validation
Run documentation validation and manually follow the documented setup/gate selection in a fresh environment.
Source references:
Non-goals
No release publication or unrelated API redesign. Preserve documented compatibility except for the defective behavior identified above.
Project fields
base-cliReadyP3Docsv1.0 ReadinessSv1.0.0Agent assignment
Assignee: @codeforester. Implementation may be handled through the normal issue-backed worktree and reviewed PR workflow.