Skip to content

feat: comply with updated standards for design docs, reqstream, and reviewmark #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Malcolmnixon merged 3 commits into from
Apr 3, 2026
Merged

feat: comply with updated standards for design docs, reqstream, and reviewmark #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b40e50
feat: comply with updated standards for design docs, reqstream, and r…
Copilot Apr 3, 2026
591bfa3
feat: remove SarifMark-OTS review set from reviewmark config
Copilot Apr 3, 2026
f9a06cf
fix: remove trailing blank line in .reviewmark.yaml to pass yamllint
Copilot Apr 3, 2026
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
18 changes: 12 additions & 6 deletions .reviewmark.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,10 @@ reviews:
- id: SarifMark-System
title: Review of SarifMark System
paths:
- "docs/reqstream/sarifmark-system.yaml"
- "docs/reqstream/system.yaml"
- "docs/reqstream/platform-requirements.yaml"
- "docs/reqstream/ots-software.yaml"
- "docs/design/introduction.md"
- "docs/design/system.md"
- "docs/reqstream/unit-program.yaml"
- "docs/design/program.md"
- "src/**/Program.cs"
- "test/**/ProgramTests.cs"
- "test/**/IntegrationTests.cs"
- "test/**/Runner.cs"
- "test/**/AssemblyInfo.cs"
Expand All @@ -54,6 +49,17 @@ reviews:
- "requirements.yaml"
- "docs/reqstream/**/*.yaml"

# ---------------------------------------------------------------------------
# Design Review
# ---------------------------------------------------------------------------

- id: SarifMark-Design
title: Review of SarifMark Design Documentation
paths:
- "docs/reqstream/system.yaml"
- "docs/reqstream/platform-requirements.yaml"
- "docs/design/**/*.md"

# ---------------------------------------------------------------------------
# Subsystem Reviews
# ---------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/design/system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ subsystem is a stateless helper used by `SelfTest` for path construction.

## System Requirements

System-level requirements are captured in `docs/reqstream/sarifmark-system.yaml`
System-level requirements are captured in `docs/reqstream/system.yaml`
and are validated through integration tests that exercise the published dotnet
DLL end-to-end across the supported platforms.

Expand Down
0 docs/reqstream/ots-software.yaml → docs/reqstream/ots/ots-software.yaml
View file
Open in desktop
File renamed without changes.
0 docs/reqstream/sarifmark-system.yaml → docs/reqstream/system.yaml
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions requirements.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#
---
includes:
- docs/reqstream/sarifmark-system.yaml
- docs/reqstream/system.yaml
- docs/reqstream/cli/subsystem-cli.yaml
- docs/reqstream/cli/unit-context.yaml
- docs/reqstream/sarif/subsystem-sarif.yaml
Expand All @@ -25,5 +25,5 @@ includes:
- docs/reqstream/utilities/subsystem-utilities.yaml
- docs/reqstream/utilities/unit-path-helpers.yaml
- docs/reqstream/platform-requirements.yaml
- docs/reqstream/ots-software.yaml
- docs/reqstream/ots/ots-software.yaml
- docs/reqstream/unit-program.yaml