Skip to content

docs: update requirements, design, and reviews to new standards#61

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/copy-updated-github-files
Apr 5, 2026
Merged

docs: update requirements, design, and reviews to new standards#61
Malcolmnixon merged 2 commits intomainfrom
copilot/copy-updated-github-files

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 5, 2026

Brings docs/design, docs/reqstream, and .reviewmark.yaml into compliance with the updated .github/standards files (synced from TemplateDotNetTool).

Test-Linkage Violations Fixed

Requirements must only link to tests in their own dedicated test suite.

  • publishing/publishing.yamlVersionMark-Publish-ConflictReport was linking to Program_Run_WithPublishCommandNoMatchingFiles_ReturnsError (a Cli unit test). Replaced with PublishingSubsystem_Run_WithGlobPattern_ReadsMatchingFiles.
  • self-test/self-test.yaml — Three subsystem requirements (Validate-Capture/Publish/Lint) each linked to CliSubsystem_Run_ValidateFlag_RunsValidation (wrong subsystem). Replaced with SelfTestSubsystem_Run_WithResultsFlag_WritesResultsFile.

Design Documentation

  • docs/design/introduction.md — Added LintIssue (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.md standard hierarchy:

  • needs-review — Added README.md and docs/user_guide/**/*.md.
  • Added Purpose review set — user-facing capabilities / advertised features review.
  • VersionMark-SystemVersionMark-Architecture — platform-requirements removed (belongs only in VersionMark-Design).
  • Subsystem reviews (e.g. VersionMark-Cli-SubsystemVersionMark-Cli) — unit design docs removed per hierarchical scope principle; subsystem reviews now rely on the subsystem design doc to describe contained units.
  • Unit reviews (e.g. VersionMark-Program-ReviewVersionMark-Cli-Program) — renamed to {System}-{Subsystem}-{Unit} pattern; VersionMark-SelfTest-Validation now includes a test file reference.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

No source code changes. reviewmark --lint, reqstream --lint, yamllint, markdownlint, and cspell all pass clean.

Copilot AI and others added 2 commits April 5, 2026 13:09
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 5, 2026 13:31
Copilot AI review requested due to automatic review settings April 5, 2026 13:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 LintIssue unit under Configuration.
  • Restructured .reviewmark.yaml review sets to match the standardized hierarchy (including a new Purpose review 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-review excludes !**/obj/** but does not exclude bin/ build outputs. The ReviewMark standard example includes both !**/bin/** and !**/obj/** (see .github/standards/reviewmark-usage.md), and including bin/ can significantly inflate review scope on developer machines. Add !**/bin/** to needs-review exclusions.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants