Skip to content

Governance ​

Governance policy for tq contract documentation.

Reference ownership and review ​

Reference pages are contract pages and require stricter ownership and review than narrative docs.

Reference sectionCanonical source(s)Required reviewer focus
docs/reference/cli.mdcrates/tq-cli/src/cli.rs + docs/reference/cli/options-manifest.json + cargo run -p tq-docsgen --locked -- generate cliCLI contract shape, flag semantics, and generated table sync
docs/reference/configuration.mdRuntime config model + docs/reference/config/examples-manifest.json + cargo run -p tq-docsgen --locked -- generate configKey/schema correctness, precedence behavior, and strict validation semantics
docs/reference/exit-codes.mdCLI/runtime exit behaviorExit contract stability and compatibility impact
docs/reference/rules/index.md and docs/reference/rules/*.mdcrates/tq-rules/src/rule_docs.rs + cargo run -p tq-docsgen --locked -- generate rulesRule ID stability, severity defaults, and per-rule contract clarity
docs/developer/versioning.mdProject versioning policy for user-visible contractsCorrect classification of breaking vs non-breaking changes

Use this review baseline for any PR that touches docs/reference/**:

  • Include at least one reviewer for the touched contract surface.
  • Keep one canonical source of truth; link instead of duplicating contract text.
  • For generated references, update the Rust-owned contract or source manifest and commit regenerated outputs in the same PR.

Rule and severity change policy ​

Rule additions and default severity changes are contract changes.

  • MUST update crates/tq-rules/src/rule_docs.rs in the same PR as runtime changes.
  • MUST include added_in and update behavior_changes for affected rules.
  • MUST regenerate rules docs via cargo run -p tq-docsgen --locked -- generate rules.
  • MUST classify release impact using versioning policy.
  • MUST summarize contract impact in CHANGELOG.md.