docs: update requirements, design, and reviews to new standards#61
Merged
Malcolmnixon merged 2 commits intomainfrom Apr 5, 2026
Merged
docs: update requirements, design, and reviews to new standards#61Malcolmnixon merged 2 commits intomainfrom
Malcolmnixon merged 2 commits intomainfrom
Conversation
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/9f13f542-41cb-4ce9-8785-d8e662915057 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/a59a4c28-7190-4d3f-8976-a367432083b1 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 13:31
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates requirements, design docs, and ReviewMark configuration to align with updated repository standards (synced from TemplateDotNetTool), including corrected requirements-to-test linkage and a restructured review-set hierarchy.
Changes:
- Fixed ReqStream test-linkage violations by pointing subsystem requirements at subsystem-level tests.
- Updated design introduction software structure to include the
LintIssueunit under Configuration. - Restructured
.reviewmark.yamlreview sets to match the standardized hierarchy (including a newPurposereview set) and refreshed standards/agent templates.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reqstream/version-mark/self-test/self-test.yaml | Updates self-test subsystem requirements to link to the correct self-test suite test. |
| docs/reqstream/version-mark/publishing/publishing.yaml | Corrects publishing requirement test linkage to a publishing subsystem test. |
| docs/design/introduction.md | Adds LintIssue to the documented Configuration subsystem structure. |
| .reviewmark.yaml | Realigns review sets and adds Purpose review coverage for README/user guide. |
| .github/standards/software-items.md | Adds naming guidance for avoiding hierarchy name collisions. |
| .github/standards/reviewmark-usage.md | Updates ReviewMark usage guidance and standard review-set hierarchy. |
| .github/standards/reqstream-usage.md | Adds explicit test-linkage hierarchy rules and clarifies YAML fields. |
| .github/standards/csharp-testing.md | Updates AAA comment guidance and introduces hierarchical test naming patterns. |
| .github/agents/repo-consistency.agent.md | Converts report template placeholders to {...} format. |
| .github/agents/quality.agent.md | Converts report template placeholders to {...} format and refines checklist wording. |
| .github/agents/implementation.agent.md | Converts report template placeholders to {...} format. |
| .github/agents/developer.agent.md | Converts report template placeholders to {...} format. |
| .github/agents/code-review.agent.md | Updates elaborate command syntax and converts placeholders to {...} format. |
Comments suppressed due to low confidence (1)
.reviewmark.yaml:16
needs-reviewexcludes!**/obj/**but does not excludebin/build outputs. The ReviewMark standard example includes both!**/bin/**and!**/obj/**(see.github/standards/reviewmark-usage.md), and includingbin/can significantly inflate review scope on developer machines. Add!**/bin/**toneeds-reviewexclusions.
needs-review:
- "README.md"
- "docs/user_guide/**/*.md"
- "**/*.cs"
- "requirements.yaml"
- "docs/reqstream/**/*.yaml"
- "docs/design/**/*.md"
- "!**/obj/**"
💡 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.
Brings
docs/design,docs/reqstream, and.reviewmark.yamlinto compliance with the updated.github/standardsfiles (synced from TemplateDotNetTool).Test-Linkage Violations Fixed
Requirements must only link to tests in their own dedicated test suite.
publishing/publishing.yaml—VersionMark-Publish-ConflictReportwas linking toProgram_Run_WithPublishCommandNoMatchingFiles_ReturnsError(a Cli unit test). Replaced withPublishingSubsystem_Run_WithGlobPattern_ReadsMatchingFiles.self-test/self-test.yaml— Three subsystem requirements (Validate-Capture/Publish/Lint) each linked toCliSubsystem_Run_ValidateFlag_RunsValidation(wrong subsystem). Replaced withSelfTestSubsystem_Run_WithResultsFlag_WritesResultsFile.Design Documentation
docs/design/introduction.md— AddedLintIssue (Unit)to the Configuration subsystem in the software structure tree; it already has a design doc, source file, and test suite but was missing from the structure diagram.ReviewMark Restructuring
Full realignment to
reviewmark-usage.mdstandard hierarchy:needs-review— AddedREADME.mdanddocs/user_guide/**/*.md.Purposereview set — user-facing capabilities / advertised features review.VersionMark-System→VersionMark-Architecture— platform-requirements removed (belongs only inVersionMark-Design).VersionMark-Cli-Subsystem→VersionMark-Cli) — unit design docs removed per hierarchical scope principle; subsystem reviews now rely on the subsystem design doc to describe contained units.VersionMark-Program-Review→VersionMark-Cli-Program) — renamed to{System}-{Subsystem}-{Unit}pattern;VersionMark-SelfTest-Validationnow includes a test file reference.Type of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
No source code changes.
reviewmark --lint,reqstream --lint,yamllint,markdownlint, andcspellall pass clean.