Skip to main content

Contributing To Origo

Purpose​

  • This page explains how to contribute safely to Origo without relying on tribal knowledge.

Required reading​

  • docs/Developer/README.md
  • docs/Developer/Governance-Reading-Guide.md
  • docs/Developer/Tests-And-Gates.md
  • README.md

Process​

  1. Read the relevant task type and shared-domain contracts through origo.governance.contract_loader.read_contracts.
  2. Confirm the canonical docs and runtime/reference pages that govern the touched surface.
  3. Check git status --short before editing and avoid reverting unrelated work.
  4. Make the smallest coherent slice that closes the user-visible or maintainer-visible gap.
  5. Update docs when the touched surface changes.
  6. Run the most relevant local validation before handing work off for review.

Contribution checklist​

  • Match the requested outcome to the correct primary task type.
  • Preserve machine governance authority in AGENTS.md and contracts/governance/*.json.
  • Update docs/Developer before docs when the change affects documentation.
  • Prefer real proofs, real workflows, and real examples.
  • Keep historical slice records as provenance, not as the primary explanation.

Failure cases and review notes​

  • Do not ship prose that conflicts with machine governance authority.
  • Do not silently reuse slice-history material as if it were current runtime truth.
  • Do not introduce a new package README that lacks outward routes to canonical docs.
  • docs/Developer/Local-Environment-And-Stack.md
  • docs/Developer/Tests-And-Gates.md
  • docs/Developer/Documentation-System.md