Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 41 additions & 41 deletions .reviewmark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,50 +25,49 @@ 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

- 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

- 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

- 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
Expand All @@ -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
Expand All @@ -87,50 +87,50 @@ 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
9 changes: 1 addition & 8 deletions docs/design/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -44,8 +43,6 @@ ReqStream (System)
│ └── Requirement (Unit)
├── Tracing (Subsystem)
│ └── TraceMatrix (Unit)
├── Linting (Subsystem)
│ └── Linter (Unit)
└── SelfTest (Subsystem)
└── Validation (Unit)
```
Expand All @@ -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
Expand All @@ -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
```
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
32 changes: 16 additions & 16 deletions requirements.yaml
Original file line number Diff line number Diff line change
@@ -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
Loading