docs(engine): document the nine governor primitives in the package README - #5851
Conversation
…ADME Add a '## Governor primitives' section to packages/loopover-engine/README.md covering the nine pure decision calculators in src/governor/ (rate-limit, budget-cap, self-plagiarism, reputation-throttle, write-rate-limit, run-halt, kill-switch, action-mode, chokepoint) — ~70 exported symbols that previously had no README narrative. Each module gets a one-paragraph summary with its key exported functions/types and a pointer to its source file, plus how chokepoint composes the other eight under its 'safest wins' precedence ladder. Cross-links the existing 'Governor ledger' section so a reader sees how the decision calculators and the append-only storage contract relate. Closes JSONbored#5817
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ LoopOver review result - approve/merge recommendedReview updated: 2026-07-14 19:41:14 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Linked issue satisfactionAddressed Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.
|
Summary
packages/loopover-engine/src/governor/holds nine fully-implemented, pure, side-effect-free decision calculators (~70 exported symbols, wired wholesale through the barrel), but the README had no narrative for any of them — the only governor heading,## Governor ledger, documents the append-only storage contract, not these decision modules (#5817).This adds a
## Governor primitivessection giving each of the nine modules a concise one-paragraph summary — what it decides, its key exported functions/types, and a pointer to the source file — mirroring the README's existing "Metadata opportunity signals" bullet-list style (discoverability, not per-function API docs):rate-limit.ts,budget-cap.ts,self-plagiarism.ts,reputation-throttle.ts,write-rate-limit.ts,run-halt.ts,kill-switch.ts,action-mode.tschokepoint.ts— how it composes the other eight into oneGovernorDecisionunder its "safest wins" precedence ladder (global kill-switch > per-repo pause > dry-run > rate-limit > budget/turn/termination cap > non-convergence > self-reputation throttle > self-plagiarism > allow), fail-closed on any throwing stage.It cross-links the existing "Governor ledger" section so a reader sees how the decision calculators and the storage contract relate.
Scope
CONTRIBUTING.md; nosite//CNAME/lovable.Validation
git diff --checkexportin the correspondingsrc/governor/*.tsfile, and the documented chokepoint precedence order matcheschokepoint.ts's own header comment verbatim.npm run docs:drift-check— passes (unaffected; the new section is additive narrative, not a flag/command/settings surface the drift check tracks).mainimmediately before pushing — no base conflict.Docs-only change to
packages/loopover-engine/README.md— outsidecodecov.yml'scoverage.include(which measuressrc/**,packages/loopover-engine/src/**,packages/loopover-miner/lib/**, not*.md), so no Codecov patch gate applies. Nosrc/**code changed, so nothing new to unit-test.If any required check was skipped, explain why:
actionlint,typecheck,test:workers,ui:*,npm auditwere not run — this changes only a Markdown file; there is no code, workflow, worker, UI, or dependency surface. The fullnpm run test:ciruns them on CI.Safety
Auth/CORS/session, API/OpenAPI/MCP, and UI safety boxes are not applicable.