Skip to content

Commit 5bd0f28

Browse files
abeltranoCopilot
andcommitted
Address second round of PR review feedback
- revise-for-readability: drop "estimated" from the quality-checklist metric source (computed / not measured) - revise-for-readability: use scalar `input_contract: null` to match the convention used by all other no-input templates - readability-gate: clarify the Output note — do not inject the gate block verbatim, but a format MAY populate its own scorecard fields from the metrics Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent df68775 commit 5bd0f28

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

protocols/guardrails/readability-gate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,10 @@ Metrics: FRE <value|not measured>, FKGL <value|not measured>,
190190
Residual issues: <count, or "None">
191191
```
192192

193-
Report this to the user (or in the change summary); do NOT inject it into the
194-
produced artifact. A consuming format MAY fold these metrics into its own
195-
scorecard section — this keeps consuming formats unchanged and avoids format
196-
drift.
193+
Report this block to the user (or in the change summary). Do NOT inject the
194+
block verbatim into the produced artifact. A consuming format MAY populate its
195+
own existing scorecard fields from these metrics — that is not injecting the
196+
block, and it keeps consuming formats unchanged and avoids format drift.
197197

198198
## Composability
199199

templates/revise-for-readability.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ params:
1919
document: "The document (or section) to revise — pasted text or a file path"
2020
target_audience: "Who reads this document (e.g., expert engineers, new team members, general technical audience); sets the readability target band"
2121
constraints: "Any terms, style rules, or sections that must be preserved verbatim, beyond the default protected tokens"
22-
input_contract:
23-
type: null
24-
description: >
25-
Any prose document or document section supplied as a parameter — Markdown,
26-
plain text, or a file path. No prior pipeline artifact is required.
22+
input_contract: null
2723
output_contract:
2824
type: readability-revision-report
2925
description: >
@@ -110,7 +106,7 @@ Before finalizing, verify:
110106
- [ ] The Revised Document section (report Section 1) contains the full revised
111107
document, usable as-is
112108
- [ ] Measurement scope lists what was included and excluded, and the metric
113-
source (computed / estimated / not measured)
109+
source (computed / not measured)
114110
- [ ] Scorecard shows before and after values for every metric, with target and
115111
status
116112
- [ ] Every protected token (normative keywords, identifiers, requirement IDs,

0 commit comments

Comments
 (0)