Files
msd-core/gsd-core/templates
Tom Boucher 4918c62d76 feat(#2845): require provenance for UI-SPEC component inventories (#3745)
* test(#2845): failing-first suite for UI-SPEC inventory provenance

Binds two shared formats before either exists, so the suite is RED against
next: the gsd-ui-checker dimension roster (asserted independently on twelve
surfaces, eight English and four translated) and the provenance-line grammar
the UI-SPEC template emits and Dimension 7 consumes.

Every parity assertion is paired with a synthetic mutation case, so the guard's
failure branch executes rather than only reading a correct tree: limit-1 (a
surface still declaring 6), limit (7), limit+1 (8), a dropped dimension, a
label that drifts on one surface only, a non-contiguous roster, a duplicated
number, and a surface that stops declaring a count at all. A seeded fast-check
property renders the roster under formatting noise (CRLF, padding, interleaved
sections) and asserts the parse round-trips and is strictly sensitive to a
dropped heading.

Assertions are on parsed typed records, never raw substrings.

* docs: normalize design-a-ui-phase how-to to American English

House style for docs/ is American English (CLAUDE.md). This file carried
colour/initialisation/initialise/artefact throughout. Spelling only — no
content change; kept separate from the #2845 feature commit so the
release-notes classifier and the hotfix cherry-pick filter see it for what
it is.

* feat(#2845): require provenance for UI-SPEC component inventories

A UI-SPEC's component inventory was treated downstream as a closed allowlist
while the document recorded nothing about whether the list had been enumerated
from the installed design system or recalled from memory. A recalled inventory
is indistinguishable from an enumerated one, so an executor complying with the
spec builds against a fraction of what the package offers, and every gate stays
green because they assert semantics rather than composition.

The UI-SPEC template gains a Component Inventory slot carrying one of two
provenance lines: the command that enumerated the list, the count it returned,
the resolved package@version and the date; or a Could not enumerate record with
a real reason. gsd-ui-researcher gains an enumeration ladder and must record
the line rather than write the list from recall.

gsd-ui-checker gains Dimension 7. An inventory with no provenance line, a count
with no command, an empty could-not-enumerate reason, or a line still carrying
the template's unfilled placeholders BLOCKs; a partial line, a line placed below
its table, or an honest negative record FLAGs; a complete line passes, and so
does a spec carrying no inventory at all, which keeps every UI-SPEC predating
the dimension validating unchanged. Whatever the verdict, an unsourced inventory
is reported as a non-exhaustive list of known-good components rather than a
closed allowlist, so the executor is never blocked from a component the spec
merely failed to mention. The checker never runs the recorded command.

The dimension count moved on all thirteen surfaces that assert it, across five
languages. Also corrects the claim in the English, Korean and Portuguese how-tos
that this checker applies a scored six-pillar rubric — that rubric belongs to
/gsd-ui-review's retroactive audit.

* chore(#2845): backfill changeset pr number to 3745

---------

Co-authored-by: sim <sim@local>
2026-08-21 11:59:56 -04:00
..

GSD Canonical Artifact Registry

This directory contains the template files for every artifact that GSD workflows officially produce. The table below is the authoritative index: if a .planning/ root file is not listed here, gsd-health will flag it as W019 (unrecognized artifact).

Agents should query this file before treating a .planning/ file as authoritative. If the file name does not appear below, it is not a canonical GSD artifact.


.planning/ Root Artifacts

These files live directly at .planning/ — not inside phase subdirectories.

File Template Produced by Purpose
PROJECT.md project.md /gsd:new-project Project identity, goals, requirements summary
ROADMAP.md roadmap.md /gsd:new-milestone, /gsd:new-project Phase plan with milestones and progress tracking
STATE.md state.md /gsd:new-project, /gsd:health --repair Current session state, active phase, last activity
REQUIREMENTS.md requirements.md /gsd:new-milestone Functional requirements with traceability
MILESTONES.md milestone.md /gsd:complete-milestone Log of completed milestones with accomplishments
BACKLOG.md (inline) /gsd-add-backlog Pending ideas and deferred work
LEARNINGS.md (inline) /gsd:extract-learnings, /gsd:execute-phase Phase retrospective learnings for future plans
THREADS.md (inline) /gsd:thread Persistent discussion threads
config.json config.json /gsd:new-project, /gsd:health --repair Project-specific GSD configuration
CLAUDE.md claude-md.md /gsd-profile Auto-assembled Claude Code context file
RETROSPECTIVE.md (inline) /gsd:complete-milestone Living milestone retrospective updated at each milestone close

Version-stamped artifacts (pattern: vX.Y-*.md)

Pattern Produced by Purpose
vX.Y-MILESTONE-AUDIT.md /gsd:audit-milestone Milestone audit report before archiving

These files are archived to .planning/milestones/ by /gsd:complete-milestone. Finding them at the .planning/ root after completion indicates the archive step was skipped.


Phase Subdirectory Artifacts (.planning/phases/NN-name/)

These files live inside a phase directory. They are NOT checked by W019 (which only inspects the .planning/ root).

File Pattern Template Produced by Purpose
NN-MM-PLAN.md phase-prompt.md /gsd:plan-phase Executable implementation plan
NN-MM-SUMMARY.md summary.md /gsd:execute-phase Post-execution summary with learnings
NN-CONTEXT.md context.md /gsd:discuss-phase Scoped discussion decisions for the phase
NN-RESEARCH.md research.md /gsd:plan-phase, /gsd:plan-phase --research-phase <N> Technical research for the phase
NN-VALIDATION.md VALIDATION.md /gsd:plan-phase (Nyquist) Validation architecture (Nyquist method)
NN-UAT.md UAT.md /gsd:validate-phase User acceptance test results
NN-PATTERNS.md (inline) /gsd:plan-phase (pattern mapper) Analog file mapping for the phase
NN-UI-SPEC.md UI-SPEC.md /gsd:ui-phase UI design contract
NN-SECURITY.md SECURITY.md /gsd:secure-phase Security threat model
NN-AI-SPEC.md AI-SPEC.md /gsd:ai-integration-phase AI integration spec with eval strategy
NN-DEBUG.md DEBUG.md /gsd:debug Debug session log
NN-REVIEWS.md (inline) /gsd:review Cross-AI review feedback

Milestone Archive (.planning/milestones/)

Files archived by /gsd:complete-milestone. These are never checked by W019.

File Pattern Source
vX.Y-ROADMAP.md Snapshot of ROADMAP.md at milestone close
vX.Y-REQUIREMENTS.md Snapshot of REQUIREMENTS.md at milestone close
vX.Y-MILESTONE-AUDIT.md Moved from .planning/ root
vX.Y-phases/ Archived phase directories (if --archive-phases used)

Adding a New Canonical Artifact

When a new workflow produces a .planning/ root file:

  1. Add the file name to CANONICAL_EXACT in gsd-core/bin/lib/artifacts.cjs
  2. Add a row to the .planning/ Root Artifacts table above
  3. Add the template to gsd-core/templates/ if one exists