Align WORKFLOW.md's Verdict Clause With Section 5's Assessment - #1390
Conversation
The preamble's verdict clause said a scenario's "observed" output, where 5B is headed "No Execution, Deterministic from the YAML" and instructs the reader to "emit the predicted ... table". It also dropped the "applicable" qualifier that N/A handling depends on, omitted the third conjunct section 5's own Assessment carries (no 5C probe that was run contradicts either), and called a mismatch a defect "not a style nit" while D9.1 through D9.5 state style rules as applicable guarantees whose failure is a defect by definition. Conjunct 1 keeps "every applicable guarantee holds" rather than Assessment's "every applicable 5A item passes". The two are not identical, since a guarantee can be applicable while its 5A check is recorded N/A, and section 1 uses the guarantee form. That difference is left as it was rather than settled here. This is the whole change. Four other corrections were attempted and withdrawn after review disproved their premises, and none of #1206's ten structural preamble items are settled, deliberately. Two unmade decisions sit under those, and both need the maintainer, because the repository states both answers. Whether D9 binds as a MUST: GOVERNANCE.md "Workflow YAML Conventions" calls the conventions a target state the repo is expected to converge on, while section 4's preamble makes any applicable violation non-operational, so an unswept workflow gets opposite verdicts. What the document is authoritative for: the blanket precedence toward GOVERNANCE.md silently retires D7.3, whose reasoning that file's boolean-inputs bullet contradicts, and GOVERNANCE.md claims precedence only for that one section. #1206's L10 is declined. It called section 2's "same line-ending policy as every other file" a misstatement, but the routed-to rule puts YAML "workflow and non-workflow alike" on the `[*]` default with no override, and `.editorconfig` names `*.bat` and `*.cmd` as the one CRLF exception. An earlier revision of this branch acted on L10 and deleted a true statement. Refs #1206, #1311 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
ⓘ Qodo reviews are paused because your trial has ended. Ask your workspace admin to add credits to resume reviews. Manage billing |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🟢 Approval recommended
The change is a narrow documentation consistency fix that makes the preamble’s verdict definition match the already-defined Assessment clause without altering any behavioral contract logic.
Pull request overview
Updates WORKFLOW.md's preamble verdict clause so it matches section 5's Assessment language, including the "predicted output" framing for 5B and the optional 5C probe contradiction check.
Changes:
- Adjust the preamble’s “Assess” verdict definition to use section 5’s “predicted output” + “5C probe” conjuncts and applicability scoping.
- Refresh the canonical-review digest metadata for the
WORKFLOW.md > (preamble)unit.
File summaries
| File | Description |
|---|---|
| WORKFLOW.md | Aligns the preamble’s operational/not-operational verdict wording with section 5’s Assessment clause. |
| reports/canonical-review.json | Updates the recorded digest/findings metadata for the WORKFLOW.md preamble unit. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…sh the WORKFLOW.md Reshape (#1397) Closes #1205. Closes #1212. Closes #1240. Closes #1250. Closes #1267. Closes #1268. Closes #1271. Closes #1288. Closes #1305. Closes #1314. Sixteen commits, ten issues. Each was driven as its own feature pull request into `develop`, reviewed by the PR-hosted reviewers, and merged only with CI green and every finding disposed of by one of the five outcomes: fixed, declined on evidence, decided by the maintainer, deferred behind a filed issue, or fixed as a class. ## What this promotes **The one-home include mechanism and its first six classes** (#1317). `scripts/build_dist.py` gained include regions filled from a rule's home and checked by `--check` (#1378), so a Skill carries a rule's whole text without a copy that can drift. Classes 2 to 6 then converted the restatements: `agent-conduct`'s three conduct sections (#1382), `pr-review-conduct`'s five outcomes into `drive-pr` with every step-ref renamed to a heading (#1383), `backlog-burndown`'s two narrowing rows cut to the narrowing with fourteen restatements pointered (#1384), `WORKFLOW.md` section 4 into `workflow-ci-contract` (#1385), and section 2 cut to a pointer at `GOVERNANCE.md` "Workflow YAML Conventions" (#1388). **The `WORKFLOW.md` reshape** (#1311 step 14's six-pull-request sequence, now finished). The verdict clause aligned with section 5's Assessment (#1390), sections 3 and 5 carried into `workflow-ci-contract` as generated includes (#1392), 5A collapsed to a procedure and an evidence rule (#1394), and the preamble decisions settled alongside the reshape of section 4, section 6 and the YAML conventions (#1395). Section 4's two longest items shrank to their outcomes with the displaced knowledge moved rather than deleted, and section 6 now states only what each type adds, carrying no N/A list at all. **The review loop's stop rule and disposition policy** (#1330), rewriting disposal by deletion and committing the condition under which a whole-unit loop ends, which #1267 filed as missing. **The Merge Gate's bound on an out-of-diff prose finding**, with the reviewer footing recorded (#1333), and reviewer bots scoped away from the generated Skill mirrors (#1329) so a mirror's diff is never reviewed in place of its source. **The fleet label set**, declared and applied through `configure.sh` (#1334). **The review ledger and skills digest decoupled from the working tree** (#1328), so concurrent branches no longer conflict in a generated report that cannot be hand-merged. Plus one grouped Dependabot bump, `docker/setup-qemu-action` 4.2.0 to 4.3.0 (#1325). ## What is deliberately not closed `#1311`, `#1317`, `#1206`, `#1367`, `#1369`, `#1370`, `#1371`, `#1386` and `#1237` each still hold findings this work did not settle. #1317 stands at class 6 of fourteen, and #1311's step 17 comment records what the reshape filed rather than fixed. ## Owed on merge `spec/files.json` declares both edited `GOVERNANCE.md` sections at `verbatim` fidelity, so every downstream copy goes stale on this promotion and a fleet resync follows it. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
First pull request of the #1311 reshape sequence recorded in
this comment.
It is one sentence, and the reason it is one sentence is the useful part.
The change
The preamble's verdict clause said a scenario's "observed" output, where 5B is headed "No
Execution, Deterministic from the YAML" and tells the reader to "emit the predicted ... table".
It also dropped the "applicable" qualifier that N/A handling depends on, omitted the third
conjunct section 5's own Assessment carries, and called a mismatch a defect "not a style nit"
while D9.1 through D9.5 state style rules as applicable guarantees whose failure is a defect by
definition.
Conjunct 1 keeps "every applicable guarantee holds" rather than Assessment's "every
applicable 5A item passes". Those are not the same set, since a guarantee can be applicable
while its 5A check is recorded N/A, and section 1 uses the guarantee form. Left as it was
rather than settled here.
Four corrections attempted and withdrawn
Review disproved the premise under each, which is worth recording because three of the four
looked obviously right when written.
section 2's "same line-ending policy as every other file" a misstatement. The routed-to rule
puts YAML "workflow and non-workflow alike, no distinction needed" on the
[*]default withno override, and
.editorconfignames*.bat/*.cmdas "the one CRLF exception". Acting onL10 deleted a true statement. L10 should be declined.
.github/workflows/evidence putpyproject.tomlandthe dependency manifests on this file's side of the WORKFLOW/CODESTYLE partition, which
nothing in the tree resolves.
CODESTYLE.mdholds:.github/actions/prose-gate/prose_lint.pyis the real 78 KB implementation, withscripts/prose_lint.pya ten-line shim, and it is linted by ruff and on the mypy path.next, including a dangerous one: dropping D1.3's layer binding would let a reader write
inputs.smoke != 'true'at the workflow layer, where the operand-type cast toNaNmakesthe smoke gate pass on every smoke run.
Two decisions this needs from the maintainer
None of #1206's ten structural preamble items are settled, because both questions under them
have the repository asserting both answers.
1. Does D9 bind as a MUST?
GOVERNANCE.md"Workflow YAML Conventions" opens "Theseconventions describe the target state ... The rest of the repo is expected to be brought up to
the same standard." Section 4's preamble says "A workflow that violates any applicable
guarantee is not operational." An unswept legacy workflow gets opposite verdicts. Four
findings (P1, P2, L3, L6) are downstream of this.
2. What is this document authoritative for? The blanket "
GOVERNANCE.mdis authoritativewherever this document overlaps it" decides a live conflict the wrong way: that file's
boolean-inputs bullet requires comparing against both forms, D7.3 says the opposite and calls
the second comparison dead, and 5A tells the auditor the both-forms shape is "redundant rather
than a finding".
GOVERNANCE.mdclaims precedence only for its own section. Six findings (P4,P5, P10, P11, L8, L9) are downstream of this.
Verification
Full local gate set from
OPERATIONS.md"Local Verification":build_dist --check,canonical_review check,repo_gate(eol, eol-coverage, sha-pin),prose_lintover 324files, the JSON parse loop,
spec/validate.py, anddocker_lint(7 linters, markdownlint over178 files). All green. A carried-content pass over the changed unit's whole text and a local
strict review of the diff are both recorded.
Refs #1206, #1311
🤖 Generated with Claude Code