Skip to content

Document the engine-layer readinessMode/readinessMinScore rename #5285

Description

@JSONbored

Context

RepositorySettings.qualityGateMode/qualityGateMinScore (src/types.ts:741-742) is correctly aliased to yml gate.readiness.mode/gate.readiness.minScore in scripts/check-docs-drift.mjs's GATE_MODE_MANIFEST and both docs pages, which correctly distinguish this gate from the separate mergeReadiness gate. What's undocumented is that packages/gittensory-engine/src/focus-manifest.ts's FocusManifestGateConfig spells the same concept a third way internally: readinessMode/readinessMinScore (lines 86-87), folded into RepositorySettings at src/signals/focus-manifest.ts:474-475. Unlike its sibling checkMode two lines above (which cross-references its DB counterpart), readinessMode/readinessMinScore carry no such comment. The identical rename recurs a fourth time in packages/gittensory-engine/src/types/predicted-gate-types.ts:284-285 (folded via predicted-gate.ts:289-290) — a consistent, systematic engine-layer convention across two independent types, not a one-off.

Low severity: scripts/check-docs-drift.mjs's own FOCUS_MANIFEST_SKIP_TOP_LEVEL_FIELDS comment (lines 172-181) already generally and deliberately documents this exact renaming pattern class with a worked example (slopMinScore/slopGateMinScore), explicitly declining exhaustive per-field enumeration by design. This is the known, accepted residue of that intentional choice — pure internal-code-readability, no user-facing doc bug.

Requirements

  • Do NOT add a check-docs-drift.mjs enforcement entry for this — that would contradict the script's own stated non-exhaustive-by-design intent.

Deliverables

  • Add a doc comment above readinessMode/readinessMinScore (packages/gittensory-engine/src/focus-manifest.ts:86-87), modeled on the neighboring checkMode comment, cross-referencing qualityGateMode/qualityGateMinScore.
  • Optionally mirror the same comment on predicted-gate-types.ts:284-285.

Expected Outcome

A reader of the engine-layer type finds a cross-reference to the field's real name in RepositorySettings, consistent with its sibling checkMode field.

Links & Resources

  • Evidence: packages/gittensory-engine/src/focus-manifest.ts:86-87,1315; src/signals/focus-manifest.ts:474; src/types.ts:741-742; src/db/schema.ts:72-73; .gittensory.yml.example:164-170,267-269; packages/gittensory-engine/src/types/predicted-gate-types.ts:284-285

Part of #5270 (roadmap epic).

Metadata

Metadata

Assignees

Labels

maintainer-onlyOwner-only work — yields no Gittensor points.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions