Skip to content

docs: add the operating discipline guide for repo agents - #9

Merged
xantorres merged 3 commits into
mainfrom
docs/operating-discipline-guide
Oct 2, 2026
Merged

xantorres merged 3 commits into
mainfrom
docs/operating-discipline-guide

Conversation

@xantorres

Copy link
Copy Markdown
Owner

What

  • Adds docs/agents/operating-discipline.md.
  • The two README commits add and then drop the code intelligence section, so the README is unchanged overall.

Verification

  • Pre-push typecheck, tests and the redaction gate pass.

@xantorres
xantorres merged commit d232da4 into main Oct 2, 2026
5 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a9a57c0201

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +35 to +37
Never run bare `rk validate` or `rk status` at session start on a mature repo:
tier 3 output is large and mostly P2 background noise
(`SHIPPED_SPRINT_MISSING_BASE_SHA` in particular). `--fail-on P0,P1` is the

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use an output-limiting flag for the low-cost tier

In the stated mature-repository scenario, --fail-on P0,P1 does not reduce the output: the CLI help defines --fail-on as a “severity threshold,” while runValidateCommand still formats every finding unless a display filter or --brief is used. Moreover, SHIPPED_SPRINT_MISSING_BASE_SHA is audit-scoped and is not included by bare rk validate or rk status; the --audit help explicitly says that historical-hygiene rules are off by default. Agents following this guidance can therefore receive the same live P2 output at tier 2, while the cited source of tier-3 noise cannot occur there. Recommend --brief when only the gate result is needed, and distinguish exit thresholds from audit scope and output filtering.

Useful? React with 👍 / 👎.

Comment on lines +137 to +139
the caps are 16 rules and 8 fanout entries. Every tier named in `then.tier`,
`then.fanout[].tier`, or `extras.routing.*` must appear in `routing.tiers` —
`rk validate --fail-on P0,P1` surfaces mismatches.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Validate routing extras before claiming the gate catches them

When extras.routing.pin_tier or prefer_tier contains a syntactically valid but unconfigured tier, rk validate --fail-on P0,P1 does not inspect it because sprint extras remain opaque to the validators; only routing later warns on stderr and exits successfully with a scored fallback. An unknown tier in extras.routing.fanout is even filtered out by buildHint without a finding. Thus the documented gate can pass and dispatch an unintended tier or incomplete fanout. Add these cross-checks to validation or stop claiming that this command surfaces all such mismatches.

Useful? React with 👍 / 👎.

extras:
routing:
complexity: deep # trivial | standard | deep — ordinal hint
prefer_tier: standard # soft preference (scorer may override)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe the preference as overriding workload scoring

For a valid prefer_tier, recommend() returns that tier before reaching the score-based fallback, so the scorer never overrides the preference; only a pin or matching policy rule takes precedence. An author following this comment could set standard expecting a sufficiently deep or high-token sprint to be upgraded automatically, but it will remain standard. Describe this as a preference that overrides scoring, while remaining subordinate to pins and rules.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant