From 3e18e1b4473f3531dfe8368498b15098b7034a33 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 2 Apr 2026 00:42:06 +0000 Subject: [PATCH 1/3] comply with design-documentation, reqstream-usage, and reviewmark-usage standards Agent-Logs-Url: https://github.com/demaconsulting/ReqStream/sessions/b1d5559d-2881-41c5-bfc1-9eb8e83a8aea Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --- .reviewmark.yaml | 93 +++++++++++-------- docs/design/introduction.md | 9 +- .../cli/{subsystem-cli.yaml => cli.yaml} | 0 .../cli/{unit-context.yaml => context.yaml} | 0 ...{subsystem-modeling.yaml => modeling.yaml} | 0 ...it-requirements.yaml => requirements.yaml} | 0 .../buildmark.yaml} | 0 .../{ots-mstest.yaml => ots/mstest.yaml} | 0 .../reviewmark.yaml} | 0 .../sarifmark.yaml} | 0 .../sonarmark.yaml} | 0 .../versionmark.yaml} | 0 .../{unit-program.yaml => program.yaml} | 0 ...ubsystem-self-test.yaml => self-test.yaml} | 0 .../{unit-validation.yaml => validation.yaml} | 0 .../{reqstream-system.yaml => system.yaml} | 0 ...it-trace-matrix.yaml => trace-matrix.yaml} | 0 .../{subsystem-tracing.yaml => tracing.yaml} | 0 requirements.yaml | 32 +++---- 19 files changed, 69 insertions(+), 65 deletions(-) rename docs/reqstream/cli/{subsystem-cli.yaml => cli.yaml} (100%) rename docs/reqstream/cli/{unit-context.yaml => context.yaml} (100%) rename docs/reqstream/modeling/{subsystem-modeling.yaml => modeling.yaml} (100%) rename docs/reqstream/modeling/{unit-requirements.yaml => requirements.yaml} (100%) rename docs/reqstream/{ots-buildmark.yaml => ots/buildmark.yaml} (100%) rename docs/reqstream/{ots-mstest.yaml => ots/mstest.yaml} (100%) rename docs/reqstream/{ots-reviewmark.yaml => ots/reviewmark.yaml} (100%) rename docs/reqstream/{ots-sarifmark.yaml => ots/sarifmark.yaml} (100%) rename docs/reqstream/{ots-sonarmark.yaml => ots/sonarmark.yaml} (100%) rename docs/reqstream/{ots-versionmark.yaml => ots/versionmark.yaml} (100%) rename docs/reqstream/{unit-program.yaml => program.yaml} (100%) rename docs/reqstream/self-test/{subsystem-self-test.yaml => self-test.yaml} (100%) rename docs/reqstream/self-test/{unit-validation.yaml => validation.yaml} (100%) rename docs/reqstream/{reqstream-system.yaml => system.yaml} (100%) rename docs/reqstream/tracing/{unit-trace-matrix.yaml => trace-matrix.yaml} (100%) rename docs/reqstream/tracing/{subsystem-tracing.yaml => tracing.yaml} (100%) diff --git a/.reviewmark.yaml b/.reviewmark.yaml index e5c953e..876d5f7 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -6,6 +6,7 @@ # Patterns identifying all files that require review. # Processed in order; prefix a pattern with '!' to exclude. needs-review: + - "requirements.yaml" # Root requirements file - "**/*.cs" # All C# source and test files - "docs/reqstream/**/*.yaml" # Requirements files - "docs/design/**/*.md" # Design documents @@ -24,11 +25,10 @@ evidence-source: # Each review-set groups requirements, source, and tests for a coherent software unit # so that an AI-assisted review can verify consistency across the full evidence chain. reviews: - # Software unit reviews - one per unit - id: ReqStream-Program title: Review of ReqStream Program Unit paths: - - "docs/reqstream/unit-program.yaml" # requirements + - "docs/reqstream/program.yaml" # requirements - "docs/design/program.md" # design - "src/**/Program.cs" # implementation - "test/**/ProgramTests.cs" # unit tests @@ -36,7 +36,7 @@ reviews: - id: ReqStream-Context title: Review of ReqStream Context Unit paths: - - "docs/reqstream/cli/unit-context.yaml" # requirements + - "docs/reqstream/cli/context.yaml" # requirements - "docs/design/cli/context.md" # design - "src/**/Cli/Context.cs" # implementation - "test/**/Cli/ContextTests.cs" # unit tests @@ -44,7 +44,7 @@ reviews: - id: ReqStream-Validation title: Review of ReqStream Validation Unit paths: - - "docs/reqstream/self-test/unit-validation.yaml" # requirements + - "docs/reqstream/self-test/validation.yaml" # requirements - "docs/design/self-test/validation.md" # design - "src/**/SelfTest/Validation.cs" # implementation - "test/**/SelfTest/ValidationTests.cs" # unit tests @@ -52,22 +52,22 @@ reviews: - id: ReqStream-Modeling title: Review of ReqStream Modeling Unit paths: - - "docs/reqstream/modeling/unit-requirements.yaml" # requirements - - "docs/design/modeling/requirements.md" # design - - "src/**/Modeling/LintIssue.cs" # implementation - - "src/**/Modeling/Requirement.cs" # implementation - - "src/**/Modeling/Requirements.cs" # implementation - - "src/**/Modeling/RequirementsLoader.cs" # implementation - - "src/**/Modeling/Section.cs" # implementation - - "test/**/Modeling/RequirementsExportTests.cs" # unit tests - - "test/**/Modeling/RequirementsLoadTests.cs" # unit tests - - "test/**/Modeling/RequirementsLoaderTests.cs" # unit tests - - "test/**/Modeling/RequirementsReadTests.cs" # unit tests + - "docs/reqstream/modeling/requirements.yaml" # requirements + - "docs/design/modeling/requirements.md" # design + - "src/**/Modeling/LintIssue.cs" # implementation + - "src/**/Modeling/Requirement.cs" # implementation + - "src/**/Modeling/Requirements.cs" # implementation + - "src/**/Modeling/RequirementsLoader.cs" # implementation + - "src/**/Modeling/Section.cs" # implementation + - "test/**/Modeling/RequirementsExportTests.cs" # unit tests + - "test/**/Modeling/RequirementsLoadTests.cs" # unit tests + - "test/**/Modeling/RequirementsLoaderTests.cs" # unit tests + - "test/**/Modeling/RequirementsReadTests.cs" # unit tests - id: ReqStream-TraceMatrix title: Review of ReqStream TraceMatrix Unit paths: - - "docs/reqstream/tracing/unit-trace-matrix.yaml" # requirements + - "docs/reqstream/tracing/trace-matrix.yaml" # requirements - "docs/design/tracing/trace-matrix.md" # design - "src/**/Tracing/TraceMatrix.cs" # implementation - "test/**/Tracing/TraceMatrixTests.cs" # unit tests @@ -78,7 +78,7 @@ reviews: - id: ReqStream-Cli title: Review of ReqStream Cli subsystem (command-line interface) paths: - - "docs/reqstream/cli/subsystem-cli.yaml" # subsystem requirements + - "docs/reqstream/cli/cli.yaml" # subsystem requirements - "docs/design/cli/cli.md" # subsystem design - "docs/design/cli/context.md" # Context unit design - "docs/design/program.md" # Program unit design @@ -87,50 +87,61 @@ reviews: - id: ReqStream-ModelingSubsystem title: Review of ReqStream Modeling subsystem (requirements data model) paths: - - "docs/reqstream/modeling/subsystem-modeling.yaml" # subsystem requirements - - "docs/design/modeling/modeling.md" # subsystem design - - "docs/design/modeling/requirements.md" # Requirements unit design - - "test/**/Modeling/ModelingIntegrationTests.cs" # subsystem integration tests + - "docs/reqstream/modeling/modeling.yaml" # subsystem requirements + - "docs/design/modeling/modeling.md" # subsystem design + - "docs/design/modeling/requirements.md" # Requirements unit design + - "test/**/Modeling/ModelingIntegrationTests.cs" # subsystem integration tests - id: ReqStream-TracingSubsystem title: Review of ReqStream Tracing subsystem (test result tracing) paths: - - "docs/reqstream/tracing/subsystem-tracing.yaml" # subsystem requirements - - "docs/design/tracing/tracing.md" # subsystem design - - "docs/design/tracing/trace-matrix.md" # TraceMatrix unit design - - "test/**/Tracing/TracingIntegrationTests.cs" # subsystem integration tests + - "docs/reqstream/tracing/tracing.yaml" # subsystem requirements + - "docs/design/tracing/tracing.md" # subsystem design + - "docs/design/tracing/trace-matrix.md" # TraceMatrix unit design + - "test/**/Tracing/TracingIntegrationTests.cs" # subsystem integration tests - id: ReqStream-SelfTestSubsystem title: Review of ReqStream SelfTest subsystem (self-validation) paths: - - "docs/reqstream/self-test/subsystem-self-test.yaml" # subsystem requirements - - "docs/design/self-test/self-test.md" # subsystem design - - "docs/design/self-test/validation.md" # Validation unit design - - "test/**/SelfTest/SelfTestIntegrationTests.cs" # subsystem integration tests + - "docs/reqstream/self-test/self-test.yaml" # subsystem requirements + - "docs/design/self-test/self-test.md" # subsystem design + - "docs/design/self-test/validation.md" # Validation unit design + - "test/**/SelfTest/SelfTestIntegrationTests.cs" # subsystem integration tests # System review - covers system-level behavior validated through integration tests - id: ReqStream-System title: Review of ReqStream system-level behavior and integration paths: - - "docs/reqstream/reqstream-system.yaml" # system requirements - - "docs/reqstream/platform-requirements.yaml" # platform requirements - - "docs/design/introduction.md" # design introduction and architecture - - "docs/design/system.md" # system integration design - - "test/**/IntegrationTests.cs" # integration tests - - "test/**/Runner.cs" # test runner infrastructure - - "test/**/AssemblyInfo.cs" # test infrastructure + - "docs/reqstream/system.yaml" # system requirements + - "docs/reqstream/platform-requirements.yaml" # platform requirements + - "docs/design/introduction.md" # design introduction and architecture + - "docs/design/system.md" # system integration design + - "test/**/IntegrationTests.cs" # integration tests + - "test/**/Runner.cs" # test runner infrastructure + - "test/**/AssemblyInfo.cs" # test infrastructure # Design review - all design documents - id: ReqStream-Design title: Review of ReqStream Software Design Document paths: - - "docs/reqstream/reqstream-system.yaml" # system requirements - - "docs/reqstream/platform-requirements.yaml" # platform requirements - - "docs/design/**/*.md" # all design documents + - "docs/reqstream/system.yaml" # system requirements + - "docs/reqstream/platform-requirements.yaml" # platform requirements + - "docs/design/**/*.md" # all design documents # Full requirements review - id: ReqStream-AllRequirements title: Review of All ReqStream Requirements for Consistency paths: - - "requirements.yaml" # root requirements file - - "docs/reqstream/**/*.yaml" # all requirements files + - "requirements.yaml" # root requirements file + - "docs/reqstream/**/*.yaml" # all requirements files + + # OTS review + - id: ReqStream-OTS + title: Review of ReqStream OTS Software Requirements + paths: + - "docs/reqstream/ots/mstest.yaml" # MSTest requirements + - "docs/reqstream/ots/buildmark.yaml" # BuildMark requirements + - "docs/reqstream/ots/versionmark.yaml" # VersionMark requirements + - "docs/reqstream/ots/sarifmark.yaml" # SarifMark requirements + - "docs/reqstream/ots/sonarmark.yaml" # SonarMark requirements + - "docs/reqstream/ots/reviewmark.yaml" # ReviewMark requirements diff --git a/docs/design/introduction.md b/docs/design/introduction.md index 1bed463..aa975a7 100644 --- a/docs/design/introduction.md +++ b/docs/design/introduction.md @@ -20,7 +20,6 @@ This document covers the detailed design of the following software units: - **Requirements, Section, and Requirement** — YAML parsing, section merging, validation, and export (`Modeling/Requirements.cs`, `Modeling/Section.cs`, `Modeling/Requirement.cs`) - **TraceMatrix** — test result loader and requirement-coverage analyzer (`Tracing/TraceMatrix.cs`) -- **Linter** — structural linter for requirement YAML files (`Linting/Linter.cs`) The following topics are out of scope: @@ -44,8 +43,6 @@ ReqStream (System) │ └── Requirement (Unit) ├── Tracing (Subsystem) │ └── TraceMatrix (Unit) -├── Linting (Subsystem) -│ └── Linter (Unit) └── SelfTest (Subsystem) └── Validation (Unit) ``` @@ -71,9 +68,6 @@ docs/design/ ├── tracing/ │ ├── tracing.md — Tracing subsystem design │ └── trace-matrix.md — TraceMatrix unit design -├── linting/ -│ ├── linting.md — Linting subsystem design -│ └── linter.md — Linter unit design └── self-test/ ├── self-test.md — SelfTest subsystem design └── validation.md — Validation unit design @@ -88,13 +82,12 @@ src/DemaConsulting.ReqStream/ ├── Cli/ │ └── Context.cs — command-line argument parser and I/O owner ├── Modeling/ +│ ├── LintIssue.cs — lint issue severity and data model │ ├── Requirement.cs — single requirement with ID, title, and test links │ ├── Requirements.cs — parsed requirements document with section tree │ └── Section.cs — named group of requirements within a document ├── Tracing/ │ └── TraceMatrix.cs — test result loader and requirement-coverage analyzer -├── Linting/ -│ └── Linter.cs — structural linter for requirement YAML files └── SelfTest/ └── Validation.cs — self-validation test runner ``` diff --git a/docs/reqstream/cli/subsystem-cli.yaml b/docs/reqstream/cli/cli.yaml similarity index 100% rename from docs/reqstream/cli/subsystem-cli.yaml rename to docs/reqstream/cli/cli.yaml diff --git a/docs/reqstream/cli/unit-context.yaml b/docs/reqstream/cli/context.yaml similarity index 100% rename from docs/reqstream/cli/unit-context.yaml rename to docs/reqstream/cli/context.yaml diff --git a/docs/reqstream/modeling/subsystem-modeling.yaml b/docs/reqstream/modeling/modeling.yaml similarity index 100% rename from docs/reqstream/modeling/subsystem-modeling.yaml rename to docs/reqstream/modeling/modeling.yaml diff --git a/docs/reqstream/modeling/unit-requirements.yaml b/docs/reqstream/modeling/requirements.yaml similarity index 100% rename from docs/reqstream/modeling/unit-requirements.yaml rename to docs/reqstream/modeling/requirements.yaml diff --git a/docs/reqstream/ots-buildmark.yaml b/docs/reqstream/ots/buildmark.yaml similarity index 100% rename from docs/reqstream/ots-buildmark.yaml rename to docs/reqstream/ots/buildmark.yaml diff --git a/docs/reqstream/ots-mstest.yaml b/docs/reqstream/ots/mstest.yaml similarity index 100% rename from docs/reqstream/ots-mstest.yaml rename to docs/reqstream/ots/mstest.yaml diff --git a/docs/reqstream/ots-reviewmark.yaml b/docs/reqstream/ots/reviewmark.yaml similarity index 100% rename from docs/reqstream/ots-reviewmark.yaml rename to docs/reqstream/ots/reviewmark.yaml diff --git a/docs/reqstream/ots-sarifmark.yaml b/docs/reqstream/ots/sarifmark.yaml similarity index 100% rename from docs/reqstream/ots-sarifmark.yaml rename to docs/reqstream/ots/sarifmark.yaml diff --git a/docs/reqstream/ots-sonarmark.yaml b/docs/reqstream/ots/sonarmark.yaml similarity index 100% rename from docs/reqstream/ots-sonarmark.yaml rename to docs/reqstream/ots/sonarmark.yaml diff --git a/docs/reqstream/ots-versionmark.yaml b/docs/reqstream/ots/versionmark.yaml similarity index 100% rename from docs/reqstream/ots-versionmark.yaml rename to docs/reqstream/ots/versionmark.yaml diff --git a/docs/reqstream/unit-program.yaml b/docs/reqstream/program.yaml similarity index 100% rename from docs/reqstream/unit-program.yaml rename to docs/reqstream/program.yaml diff --git a/docs/reqstream/self-test/subsystem-self-test.yaml b/docs/reqstream/self-test/self-test.yaml similarity index 100% rename from docs/reqstream/self-test/subsystem-self-test.yaml rename to docs/reqstream/self-test/self-test.yaml diff --git a/docs/reqstream/self-test/unit-validation.yaml b/docs/reqstream/self-test/validation.yaml similarity index 100% rename from docs/reqstream/self-test/unit-validation.yaml rename to docs/reqstream/self-test/validation.yaml diff --git a/docs/reqstream/reqstream-system.yaml b/docs/reqstream/system.yaml similarity index 100% rename from docs/reqstream/reqstream-system.yaml rename to docs/reqstream/system.yaml diff --git a/docs/reqstream/tracing/unit-trace-matrix.yaml b/docs/reqstream/tracing/trace-matrix.yaml similarity index 100% rename from docs/reqstream/tracing/unit-trace-matrix.yaml rename to docs/reqstream/tracing/trace-matrix.yaml diff --git a/docs/reqstream/tracing/subsystem-tracing.yaml b/docs/reqstream/tracing/tracing.yaml similarity index 100% rename from docs/reqstream/tracing/subsystem-tracing.yaml rename to docs/reqstream/tracing/tracing.yaml diff --git a/requirements.yaml b/requirements.yaml index 3f4b6f5..35dea11 100644 --- a/requirements.yaml +++ b/requirements.yaml @@ -1,26 +1,26 @@ --- includes: # System-level requirements - - docs/reqstream/reqstream-system.yaml + - docs/reqstream/system.yaml # Program unit - - docs/reqstream/unit-program.yaml + - docs/reqstream/program.yaml # Cli subsystem - - docs/reqstream/cli/subsystem-cli.yaml - - docs/reqstream/cli/unit-context.yaml + - docs/reqstream/cli/cli.yaml + - docs/reqstream/cli/context.yaml # Modeling subsystem - - docs/reqstream/modeling/subsystem-modeling.yaml - - docs/reqstream/modeling/unit-requirements.yaml + - docs/reqstream/modeling/modeling.yaml + - docs/reqstream/modeling/requirements.yaml # Tracing subsystem - - docs/reqstream/tracing/subsystem-tracing.yaml - - docs/reqstream/tracing/unit-trace-matrix.yaml + - docs/reqstream/tracing/tracing.yaml + - docs/reqstream/tracing/trace-matrix.yaml # SelfTest subsystem - - docs/reqstream/self-test/subsystem-self-test.yaml - - docs/reqstream/self-test/unit-validation.yaml + - docs/reqstream/self-test/self-test.yaml + - docs/reqstream/self-test/validation.yaml # Platform support and OTS software - docs/reqstream/platform-requirements.yaml - - docs/reqstream/ots-mstest.yaml - - docs/reqstream/ots-buildmark.yaml - - docs/reqstream/ots-versionmark.yaml - - docs/reqstream/ots-sarifmark.yaml - - docs/reqstream/ots-sonarmark.yaml - - docs/reqstream/ots-reviewmark.yaml + - docs/reqstream/ots/mstest.yaml + - docs/reqstream/ots/buildmark.yaml + - docs/reqstream/ots/versionmark.yaml + - docs/reqstream/ots/sarifmark.yaml + - docs/reqstream/ots/sonarmark.yaml + - docs/reqstream/ots/reviewmark.yaml From 1a519d351315bbbeb0ac7dc3b957b536f02e2b77 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 2 Apr 2026 13:15:51 +0000 Subject: [PATCH 2/3] remove redundant ReqStream-OTS review-set (covered by ReqStream-AllRequirements) Agent-Logs-Url: https://github.com/demaconsulting/ReqStream/sessions/00b814e4-e460-4933-95c5-76c0f36ced47 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --- .reviewmark.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/.reviewmark.yaml b/.reviewmark.yaml index 876d5f7..7974a90 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -135,13 +135,3 @@ reviews: - "requirements.yaml" # root requirements file - "docs/reqstream/**/*.yaml" # all requirements files - # OTS review - - id: ReqStream-OTS - title: Review of ReqStream OTS Software Requirements - paths: - - "docs/reqstream/ots/mstest.yaml" # MSTest requirements - - "docs/reqstream/ots/buildmark.yaml" # BuildMark requirements - - "docs/reqstream/ots/versionmark.yaml" # VersionMark requirements - - "docs/reqstream/ots/sarifmark.yaml" # SarifMark requirements - - "docs/reqstream/ots/sonarmark.yaml" # SonarMark requirements - - "docs/reqstream/ots/reviewmark.yaml" # ReviewMark requirements From 335442b2cccd4065c7f2c0a046ae9c5fdb0c67df Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 2 Apr 2026 13:26:19 +0000 Subject: [PATCH 3/3] fix yamllint empty-lines error in .reviewmark.yaml Agent-Logs-Url: https://github.com/demaconsulting/ReqStream/sessions/576423a7-a19e-4a8e-880f-074654a1f509 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --- .reviewmark.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.reviewmark.yaml b/.reviewmark.yaml index 7974a90..3395ef4 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -134,4 +134,3 @@ reviews: paths: - "requirements.yaml" # root requirements file - "docs/reqstream/**/*.yaml" # all requirements files -