chore(specs): normalize requirement headings to Form A per ADR-037#138
Merged
Merged
Conversation
Phase 1c migration for openbuilt (umbrella issue #137). Form A migration: 150 requirements across 17 specs migrated from Form D ("### Requirement: REQ-OBxxx-NNN <Title>") to Form A ("### Requirement: <Title>" + "**ID:** REQ-OBxxx-NNN" in body, placed after the lead SHALL paragraph so the openspec validator's "SHALL on first body line" rule still holds). Per-spec migration counts (legacy heading → Form A): - app-icon-management: 4 - app-nav-entries: 4 - application-creation-wizard: 11 - application-detail-overview: 12 - application-insights: 7 - application-versions: 8 - green-field-migration: 4 - openbuilt-application-register: 8 - openbuilt-exporter: 0 (already Form C; Purpose updated only) - openbuilt-page-designer: 11 - openbuilt-rbac: 7 - openbuilt-runtime: 17 (includes duplicate-REQ disambiguation, see below) - openbuilt-schema-designer: 8 - openbuilt-template-catalogue: 10 - openbuilt-version-snapshots: 3 - version-promotion: 11 - version-routing: 9 Total: 134 Form D → Form A migrations + 16 Form C (exporter only Purpose). Duplicate-REQ disambiguation in openbuilt-runtime (10 requirements): The runtime spec's archived deltas from openbuilt-schema-editor, openbuilt-versioning, and openbuilt-rbac all introduced REQs that collided on REQ-OBR-006 through REQ-OBR-009. Disambiguated with single-letter suffixes mapped to source archive delta: - REQ-OBR-006a = Schema designer routes (from openbuilt-schema-editor) - REQ-OBR-006b = Publish action (from openbuilt-versioning) - REQ-OBR-006c = Manifest 403 RBAC gate (from openbuilt-rbac) - REQ-OBR-007a = Schemas menu entry (from openbuilt-schema-editor) - REQ-OBR-007b = Draft-vs-published indicator (from openbuilt-versioning) - REQ-OBR-007c = List filters by role (from openbuilt-rbac) - REQ-OBR-008a = VersionHistory panel (from openbuilt-versioning) - REQ-OBR-008b = Editor UIs gate destructive actions (from openbuilt-rbac) - REQ-OBR-009a = Rollback action (from openbuilt-versioning) - REQ-OBR-009b = Caller's group set via IInitialState (from openbuilt-rbac) Each suffixed REQ carries an inline disambiguation note citing the original archive delta source and the 2026-05-24 assignment date. Purpose-block rewrites: 17 (every spec had the placeholder "TBD - created by archiving change …" text; replaced with meaningful one-paragraph purpose synthesised from the originating archived change's proposal.md "Why" section). Validation: - npx openspec validate --specs --strict: 17/17 pass. - openspec validate --all --strict: 19/20 pass. The one failure (change/openbuilt-page-designer) is a pre-existing issue on an in-flight change unrelated to this PR (no delta sections); diff shows zero edits to that path under this branch. Refs ADR-037 (ConductionNL/hydra#326). Closes part of #137.
rubenvdlinde
added
yolo
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ❌ | ||||
| phpcs | ❌ | ||||
| phpmd | ❌ | ||||
| psalm | ❌ | ||||
| phpstan | ❌ | ||||
| phpmetrics | ❌ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ❌ | ❌ | |||
| npm | ✅ | ✅ 591/591 | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-24 12:07 UTC
Download the full PDF report from the workflow artifacts.
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
Phase 1c migration for openbuilt — converts every spec under
openspec/specs/from Form D (### Requirement: REQ-OBxxx-NNN <Title>) to canonical Form A (### Requirement: <Title>+**ID:** REQ-OBxxx-NNNin body) per ADR-037, disambiguates 10 duplicate REQ IDs inopenbuilt-runtime/spec.mdintroduced by concatenated archive deltas, and replaces everyTBD - created by archiving change …Purpose placeholder with meaningful content synthesised from the originating archived change'sproposal.mdWhy section.What changed
openspec/specs/*/spec.md)TBDto real proseopenbuilt-runtimedisambiguated with single-letter suffixes mapped to source archive delta, each with an inline disambiguation note (e.g.REQ-OBR-006a= Schema designer routes fromopenbuilt-schema-editor;REQ-OBR-006b= Publish action fromopenbuilt-versioning;REQ-OBR-006c= Manifest 403 RBAC gate fromopenbuilt-rbac)Validation
openspec validate --all --strictreports 19/20 pass. The one failure ischange/openbuilt-page-designer— a pre-existing issue on an in-flight change unrelated to this PR (git diffshows zero edits to that path under this branch).Format details
Per ADR-037 the canonical heading is
### Requirement: <Title>with the REQ ID in the body. To satisfy openspec's validator rule "first body line MUST contain SHALL or MUST", the**ID:** REQ-OBxxx-NNNline is placed AFTER the lead SHALL paragraph (not before — that would make the ID line the validator-checked text and fail).References
Test plan
npx openspec validate --specs --strictpasses locallyopenbuilt-runtime/spec.mdeach carry an inline note explaining the suffix derivation