base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document requirements variable report fields

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-12 17:43:54 +00:00
parent 92c1d49ade
commit e5faa1855d
2 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/roadmap/remediation.md
View File

@@ -1,6 +1,6 @@
# PromptKit requirements inspection review
Status: R-1 completed; R-2 and R-3 open. This document records follow-up work;
Status: R-1 and R-2 completed; R-3 open. This document records follow-up work;
the review does not change implementation or current contracts.
## Review scope and authority
@@ -57,7 +57,7 @@ or test changes were needed.
## R-2: Complete the canonical requirements YAML schema
Status: open. Priority: normal. Category: incomplete documentation delivery.
Status: completed. Priority: normal. Category: incomplete documentation delivery.
**Evidence:** [CLI reference](../cli.md), lines 428–451, describes the report
shape but illustrates `variables: []` without defining variable-entry fields
@@ -90,6 +90,13 @@ owner, and the example matches the existing native/consumer evidence. Review
local links and document whitespace. Production serialization and test fixtures
need no changes to repair this omission.
**Completed:** Documented all four variable-entry fields and native exact-key
presence independently of classification/completeness. The partial-report example
now includes the unsupplied `mode` entry and upstream human-readable summaries.
Reviewed all example fields against the private report types and existing native
and report coverage; a field-inventory check, local links/fragments, and
`git diff --check` passed. Production serialization and fixtures are unchanged.
## R-3: Remove an incidental YAML key-order requirement from a test
Status: open. Priority: low. Category: inadvertently strengthened test contract.