fix(markdown-format): remove internal fleet-audit jargon from consumer-facing text - #503
Conversation
…r-facing text
De-jargon consumer-facing shipped prose. Rewrite CHANGELOG entries in place to
preserve the factual record while dropping maintainer-internal audit vocabulary
("dim N", "fleet conformance wave", "prerequisite-visibility wave") and a
sibling-plugin reference (described generically as "git-guard hooks"). Strip
"(dim-9 doctrine)" from two hook.sh comments and rename "medley-policy" to
"repo-specific policy" in test comments/messages.
Hook edits are comments and human-readable ok/fail message strings only — zero
behavior change (the 'commit/CI will block' grep assertion is untouched; 65/65
contract tests pass). Patch version bump for docs/comment hygiene.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011V31qpAHP3jfs76B9d5Rfo
|
Claude finished @kyle-sexton's task in 1m 53s —— View job PR Review:
|
| Entry | Change | Assessment |
|---|---|---|
[0.5.3] |
New entry | Well-written; consumer-meaningful; correctly classified under Changed |
[0.5.1] |
Drops trailing fleet-audit sentence | Sentence is grammatically complete after trim |
[0.5.0] |
Removes "(fleet conformance wave, dim 8 — the fleet's first conforming exemplar)" from bold heading | Period added correctly inside the bold span |
[0.4.1] |
"the guardrails plugin's git guards" → "git-guard hooks"; "the" → "a" | Cross-plugin reference eliminated; article change appropriate for generic consumer description |
[0.4.0] |
Removes "(prerequisite-visibility wave)" from bold heading | Same pattern as [0.5.0]; period added correctly |
A grep over the current state of all three plugin files confirms zero residual instances of "fleet", "dim-", "medley", "conformance wave", "visibility wave", or "guardrails plugin".
markdown-format.sh — comments only
Two edits, both removing (dim-9 doctrine) from inline comments at line 52 and line 154. Both comments read naturally after the removal. No logic, control flow, or exit paths touched.
markdown-format.test.sh — test messages only, assertion unchanged
Four edits rename "medley-policy" / "medley policy" to "repo-specific policy" across: the header docstring, the ok/fail comment above the assertion, and the two ok/fail message strings. The load-bearing grep at line 205 — grep -qi 'commit/CI will block' — is unchanged, confirming "medley" was never part of any assertion and the 65/65 pass count claim is credible.
No concerns
No executable code changed, no security surface altered, no behavior delta possible. The [0.4.0] cleanup that wasn't in the original issue's enumerated list is the right call — same jargon class, same consumer-facing file, leaving it would have made the hygiene pass incomplete.
… waits on The scenario named #503's intended dispatch and both outcomes but never the operator's ratify-or-decline answer, so recording the ratification required presuming it from the framing - the same missing-turn defect the #418 row had. The operator's "ratified" response is now part of the scenario, and the expectation covers both waits.
Summary
Internal fleet-audit jargon and internal/sibling names leaked into consumer-facing shipped files for the
markdown-formatplugin. The CHANGELOG is definitively consumer-facing (read on version bumps), so external consumers saw maintainer-only vocabulary that means nothing to them, plus a cross-reference to a sibling plugin. This is a prose-hygiene pass — not a config seam.Fix
0.5.1: dropped the trailing "the same class fix applied across the fleet's other hook-plugin setups".0.5.0: removed "(fleet conformance wave, dim 8 — the fleet's first conforming exemplar)".0.4.1: sibling-plugin reference ("the guardrails plugin's git guards") described generically as "git-guard hooks" — also satisfies the never-cross-reference-plugin-names rule.0.4.0: removed the same-class "(prerequisite-visibility wave)" rollout jargon. This instance was not in the issue's enumerated list but is the identical jargon class in the same consumer-facing file; removed deliberately so the hygiene pass is complete rather than leaving matching jargon behind.ok/failmessage strings.0.5.3CHANGELOG entry and bumpedplugin.json0.5.2 → 0.5.3(docs/comment hygiene = patch), mirroring PR refactor(hooks): read stdin via hook::buffer_stdin in advisory hooks (8 plugins) #443's two-file convention.marketplace.jsoncarries no version field, soplugin.jsonis the sole version source.Zero behavior change (hook files)
Hook
.sh/.test.shedits are comments and human-readableok/failmessage strings only. No executable logic, control flow, or matched pattern changed. Critically, the test's residual-prose assertion greps the literal'commit/CI will block'(unchanged) — "medley" was never load-bearing in any assertion.Verification
All gates run against the changed files; all pass, none suppressed:
--config .markdownlint-cli2.jsonc) onCHANGELOG.md→0 error(s)..shellcheckrc) on both changed hook.sh/.test.sh→ clean (exit 0)._typos.toml) onplugins/markdown-format/→ clean (exit 0). Removing "medley"/"dim" altered no allowlist entries (none existed for these terms).markdown-format.test.sh) →PASS=65 FAIL=0, empirically confirming no behavior change.Related
🤖 Generated with Claude Code