Organization-wide defaults for the Active Inference Institute on GitHub.
- Documentation: the readiness standard, the checker, the ledger and the reusable workflows
- Agent readiness standard: what every Institute repository is measured against
- Community-health defaults: files every repository inherits
- Development: install, lint, typecheck and test
TODO.md: known gaps and owner decisions
The modular documentation lives in docs/:
| Document | Covers |
|---|---|
docs/standard.md |
the criterion catalogue, the five kinds, tiers and adoption |
docs/checker.md |
check_readiness.py: CLI, report schema, exit codes, determinism |
docs/ledger.md |
the public-only ledger, its builder and the boundary command |
docs/workflows.md |
the reusable workflow_call workflows and the composite action |
docs/testing.md |
the offline suite, lint and typecheck |
The criterion contract itself stays beside its data: standards/README.md.
profile/README.md: the public organization profile shown at github.com/ActiveInferenceInstituteCONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md,SUPPORT.md: default community health filesPULL_REQUEST_TEMPLATE.mdand.github/ISSUE_TEMPLATE/: default pull request and issue templates
These defaults apply to any repository in the organization that does not have its own version of a file. To override one for a single repository, add a file with the same name to that repository.
This repository publishes the organization-wide readiness standard every
ActiveInferenceInstitute repository is measured against: the criterion catalogue,
a deterministic checker, and the published ledger. Criteria are data
(standards/tiers.yaml); the human contract — the five
kinds, the five statuses, exit codes, tiers and the ratchet — is in
standards/README.md, and the public-only ledger is
standards/public-ledger.json.
# Report for one repository (deterministic JSON).
uv run python scripts/check_readiness.py --repo OWNER/REPO --path PATH_TO_REPO --json
# Blocking gate for one repository.
uv run python scripts/check_readiness.py --repo OWNER/REPO --path PATH_TO_REPO --check
# Fleet report from the configured scope (never enumerate the organization).
uv run python scripts/check_readiness.py --all --scope /path/to/scope.tsv --json
# Publish the public-only ledger, then prove its boundary.
uv run python scripts/build_public_ledger.py \
--report /tmp/fleet.json --scope /path/to/scope.tsv --out standards/public-ledger.json
uv run python scripts/check_ledger_boundary.py \
--ledger standards/public-ledger.json --scope /path/to/scope.tsvPython 3.15, driven by uv; the toolchain is pinned by uv.lock. See
docs/testing.md for the full gate list.
uv sync --frozen # install the locked toolchain
uv run pytest -q # offline suite
uv run ruff check . # lint
uv run mypy scripts # typecheck
actionlint # lint the reusable workflowsThe suite is fully offline, including the github-api kind (exercised through an injected
client). The fleet report and the ledger need the owner's scope table and are not runnable from
a bare checkout; the readiness gate needs --github with an authenticated token because the
CORE-INHERIT-* criteria are API reads.
This repository carries a committed .aii/ sidecar with curated
InstituteOS metadata (aii-sidecar/v1): category, maturity, ecosystem relations,
key artifacts, provenance, and portable tasks. It is read by
InstituteOS tooling and
does not affect the project's build or runtime.