Contributing¶
Git and GitHub are the system of record. Read repository AGENTS.md, use or
create the applicable Issue, and make tracked changes only in its registered
Issue-linked worktree. Ordinary work reaches main through a pull request.
Verification¶
Classify the produced artifact with python3 scripts/verification_policy.py.
Run focused checks while iterating. Code, configuration, packaging,
installation-contract, security, CI, and test candidates run:
To run one named test module, use the focused profile with its repository-relative test path. For example:
python3 scripts/quality_gate.py run --profile focused --test tests/test_docs.py
The test directory is not an import package, so do not invoke a focused module
as python3 -m unittest tests.test_docs. The focused profile preserves the
canonical discovery-based test invocation.
Review-stable code, configuration, packaging, installation-contract, security, CI, and test candidates run:
python3 scripts/quality_gate.py run --profile required
Merge requires the exact-head hosted validate check. A failed, skipped,
stale, or unavailable result blocks acceptance until a new exact-head hosted
run succeeds; a local result never substitutes for that gate.
Documentation changes¶
Follow documentation governance. Update English canonical content and the official Japanese translation together, regenerate machine-derived pages, and run:
python3 scripts/docs.py generate
python3 scripts/docs.py check
The check includes a strict MkDocs build. Generated HTML under site/ is
disposable and ignored.