fix(#2787): clarify broken-windows ship blocking enforcement (#2814)

* fix(#2787): clarify broken-windows ship blocking enforcement

* fix(#2787): update renderLedger header to clarify opt-in enforcement

* fix(#2787): address maintainer scope and wording review

---------

Co-authored-by: Tom Boucher <trekkie@nomorestars.com>
This commit is contained in:
Dennis Kim
2026-08-03 12:39:16 -04:00
committed by GitHub
parent d3ddcaba1c
commit 178ec00040
5 changed files with 54 additions and 6 deletions

View File

@@ -1,10 +1,10 @@
/**
* Broken-windows ledger — enforced cross-phase defect register (issue #1950).
* Broken-windows ledger — optionally enforced cross-phase defect register (issue #1950).
*
* Manages `.planning/WINDOWS.md`: a cross-phase ledger of small defects (stubs,
* TODOs, skipped tests, lint warnings, unrun verifies, unmet truths, deviations).
* `/gsd-ship` blocks while any entry is `open`; an entry can be `waived` only
* with a recorded reason or `fixed`.
* When `workflow.windows_enforce` is true, `/gsd-ship` blocks while any entry is
* `open`; an entry can be `waived` only with a recorded reason or `fixed`.
*
* LEAF MODULE — imports ONLY: node:fs, node:path. No other src/ imports.
*
@@ -596,7 +596,7 @@ export function renderLedger(ledger: Ledger): string {
const header = [
'# Broken Windows Ledger',
'',
'> Cross-phase defect register. `/gsd-ship` blocks while `open_count > 0`.',
'> Cross-phase defect register. With `workflow.windows_enforce` enabled, `/gsd-ship` blocks while `open_count > 0`.',
'> Waive with `gsd-tools windows waive <id> "<reason>"` (reason required).',
'> Mark fixed with `gsd-tools windows fixed <id>`.',
'',