Fix wrong requirement ID references in validation.md design doc#62
Merged
Malcolmnixon merged 1 commit intomainfrom Apr 5, 2026
Merged
Fix wrong requirement ID references in validation.md design doc#62Malcolmnixon merged 1 commit intomainfrom
Malcolmnixon merged 1 commit intomainfrom
Conversation
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/10007d11-f32c-4800-9594-d068e4859941 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
Malcolmnixon
April 5, 2026 14:44
View session
Malcolmnixon
approved these changes
Apr 5, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes incorrect requirement ID cross-references in the Validation unit design doc so the documented self-tests map to the correct Validation unit requirements (and the correct subsystem-level “Results” requirement).
Changes:
- Updated
RunCaptureTest,RunPublishTest, and lint test sections to referenceVersionMark-Validation-*requirement IDs. - Updated
WriteResultsFileto referenceVersionMark-Validate-Results(subsystem-level requirement inself-test.yaml).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Apr 12, 2026
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
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
Performed formal review of all 18 review-sets defined in
.reviewmark.yaml. One actionable issue was found and fixed.Issue Found
docs/design/version-mark/self-test/validation.mdcontained incorrect requirement ID cross-references. The design doc was referencing requirement IDs from other subsystems instead of the correct unit/subsystem requirement IDs:VersionMark-Capture-CaptureVersionMark-Validation-CaptureVersionMark-Publish-PublishVersionMark-Validation-PublishVersionMark-CommandLine-LintVersionMark-Validation-LintVersionMark-CommandLine-LintVersionMark-Validation-LintVersionMark-CommandLine-ResultsVersionMark-Validate-ResultsNote:
VersionMark-Validate-Results(subsystem level, inself-test.yaml) is the correct reference forWriteResultsFilesince there is no unit-levelVersionMark-Validation-Resultsrequirement invalidation.yaml.Review Reports
All 18 review reports were written to
.agent-logs/(excluded from git):review-Purpose.md— PASSreview-VersionMark-Architecture.md— PASSreview-VersionMark-Design.md— PASSreview-VersionMark-AllRequirements.md— PASSreview-VersionMark-Cli.md— PASS (minor test coverage notes, no actionable doc fixes)review-VersionMark-Cli-Program.md— PASSreview-VersionMark-Cli-Context.md— PASSreview-VersionMark-Configuration.md— PASS (brief subsystem docs are by design per hierarchical scope principle)review-VersionMark-Configuration-VersionMarkConfig.md— PASSreview-VersionMark-Configuration-ToolConfig.md— PASSreview-VersionMark-Configuration-LintIssue.md— PASSreview-VersionMark-Capture.md— PASS (brief subsystem doc is by design)review-VersionMark-Capture-VersionInfo.md— PASSreview-VersionMark-Publishing.md— PASSreview-VersionMark-Publishing-MarkdownFormatter.md— PASSreview-VersionMark-SelfTest.md— PASSreview-VersionMark-SelfTest-Validation.md— fixed by this PRreview-VersionMark-SelfTest-PathHelpers.md— PASS