Skip to content

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

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/update-repository-to-compliance
Apr 3, 2026
Merged

feat: comply with updated standards for design docs, reqstream, and reviewmark#87
Malcolmnixon merged 3 commits intomainfrom
copilot/update-repository-to-compliance

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

Pull Request

Description

Updates the repository to comply with the updated .github/standards for design documentation, requirements management (ReqStream), and file reviews (ReviewMark).

Requirements structure (reqstream-usage.md)

  • Renamed docs/reqstream/sarifmark-system.yamldocs/reqstream/system.yaml (standard requires system.yaml name)
  • Moved docs/reqstream/ots-software.yamldocs/reqstream/ots/ots-software.yaml (standard requires OTS requirements in ots/ subfolder)
  • Updated requirements.yaml includes to reference new paths

Design documentation (design-documentation.md)

  • Updated docs/design/system.md prose reference from old sarifmark-system.yaml path to new system.yaml path

ReviewMark configuration (reviewmark-usage.md)

  • Fixed SarifMark-System review: updated path to docs/reqstream/system.yaml, removed OTS and Program-unit items that belong in their own dedicated reviews
  • Added SarifMark-Design review set (covers all design documents — required by standard)

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.SarifMark --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:

  • All linters pass: ./lint.sh (Unix/macOS) or cmd /c lint.bat / ./lint.bat (Windows)

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 or test logic changed — this is purely a structural/compliance update to docs, requirements organisation, and review configuration.

…eviewmark

Agent-Logs-Url: https://github.com/demaconsulting/SarifMark/sessions/b51e81ae-3c8e-484e-8e6a-3236e2ef586c

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/SarifMark/sessions/91065279-41b9-415a-8317-81fb74bf0b57

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI requested a review from Malcolmnixon April 3, 2026 00:30
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 3, 2026 00:41
Copilot AI review requested due to automatic review settings April 3, 2026 00:41
@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot Please fix issues reported by linting.

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 repository documentation/configuration files to align with the latest .github/standards expectations for ReqStream and ReviewMark, primarily by standardizing requirement file locations/names and updating references.

Changes:

  • Updated requirements.yaml includes to reference docs/reqstream/system.yaml and docs/reqstream/ots/ots-software.yaml.
  • Added the new docs/reqstream/system.yaml and moved OTS requirements under docs/reqstream/ots/.
  • Updated .reviewmark.yaml review-sets to point at the new requirement paths and added a dedicated SarifMark-Design review-set.

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
requirements.yaml Updates included requirement file paths to match standardized ReqStream layout.
docs/reqstream/system.yaml Introduces standardized system-level requirements file location/name.
docs/reqstream/ots/ots-software.yaml Places OTS requirements under the required docs/reqstream/ots/ folder.
docs/design/system.md Updates prose reference to the renamed/moved system requirements file.
.reviewmark.yaml Updates review paths for new reqstream layout and adds a design review-set.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 3, 2026

@copilot Please fix issues reported by linting.

Fixed in f9a06cf — removed the trailing blank line in .reviewmark.yaml that was left after removing the OTS review section. Lint now passes cleanly.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

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