feat: add metadata.yaml format reference for scaffolding skills#88
Merged
Conversation
- add references/metadata-format.hbs as the single serialization-format authority for metadata.yaml (canonical field order, minimal quoting, ISO 8601 created_at, quality_log entry shape); defers field semantics to ChangeMetadataSchema and status values to _status-lifecycle.md - register it in getSkillReferences for prospec-new-story and prospec-ff so agent sync deploys it self-contained into each skill's references/ - load it in new-story (Startup Loading MANDATORY) and ff (Phase 2 on-demand); point plan/tasks/implement/review/verify/archive at it via soft references when they append or edit metadata fields - add skill-contract assertions (named-set + deploy/cite + content pins); update startup-loading baseline; regenerate bundled templates; sync counts Closes the metadata.yaml format-drift gap: scaffolding skills previously invented field order, quoting, and date format per invocation.
… REQs - graduate REQ-TEMPLATES-150 into sdd-workflow.md (US-1) and REQ-AGNT-037 into agent-integration.md (US-401); bump req_count + Change History in both - add committed spec history under _archived-history/ (the gitignored archive bundle's only version-controlled record) - harvest the review findings into the lessons ledger as PB-003 (docs-claims) re-evidence: a format-authority reference must itself exemplify the format it defines (its examples must round-trip through the real serializer) - refresh raw-scan.md for the next knowledge-generate
Prospec Check |
Test Coverage
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
metadata.yamlwas the only core change artifact without a format reference — every other artifact (proposal, plan, delta-spec, tasks) has areferences/*-formatdoc thatagent syncdeploys and the skill loads on a MANDATORY read. Without one,/prospec-new-storyand/prospec-ffinvented the field order, quoting, and date format per invocation. The drift is visible across archived changes:created_atas full ISO vs bare date vs quoted;related_modulesentries carrying**bold**markdown; verify records putting the grade inresultinstead ofgrade; inconsistentrelated_modules↔descriptionordering.What changed
references/metadata-format.hbs— the single serialization-format authority formetadata.yaml: canonical field order, minimal quoting, ISO 8601created_at, and thequality_logentry shape (resultstays the gate three-state; the verify grade lives ingrade, never inresult). It documents format only and defers field semantics toChangeMetadataSchema(src/types/change.ts) and status values to_status-lifecycle.md, so it never restates a single-source contract.getSkillReferencesforprospec-new-storyandprospec-ff, soagent syncdeploys it self-contained into each skill'sreferences/(both alreadyhasReferences: true— no flag flip).[STABLE] MANDATORYStartup Loading item; ff loads it on-demand at Phase 2 (matching its lean-prefix convention). The downstream skills that append metadata fields (plan / tasks / implement / review / verify / archive) point at it via soft references when they writequality_log/status/grade— soft (notreferences/…mdlinks) so the self-containment contract stays intact, since only new-story and ff bundle the file.New requirements
REQ-TEMPLATES-150(sdd-workflow) — the metadata-format reference, its skill loading, and the downstream pointers.REQ-AGNT-037(agent-integration) — registration ingetSkillReferencesand self-contained deployment.Verification
pnpm typecheckclean ·pnpm lintclean ·pnpm test2135/2135 greendimensionsexample used flow-style YAML, contradicting its "exactly what stringifyYaml emits" claim (now block-style, harvested into the lessons ledger as a PB-003 re-evidence — a format-authority reference must itself exemplify the format it defines).