feat: comply with updated standards for design docs, reqstream, and reviewmark#87
Conversation
…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 Please fix issues reported by linting. |
There was a problem hiding this comment.
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.yamlincludes to referencedocs/reqstream/system.yamlanddocs/reqstream/ots/ots-software.yaml. - Added the new
docs/reqstream/system.yamland moved OTS requirements underdocs/reqstream/ots/. - Updated
.reviewmark.yamlreview-sets to point at the new requirement paths and added a dedicatedSarifMark-Designreview-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.
Agent-Logs-Url: https://github.com/demaconsulting/SarifMark/sessions/5f7456a2-2f58-4358-a249-14aaf026aac1 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Fixed in f9a06cf — removed the trailing blank line in 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:
If you need me to access, download, or install something from one of these locations, you can either:
|
Pull Request
Description
Updates the repository to comply with the updated
.github/standardsfor design documentation, requirements management (ReqStream), and file reviews (ReviewMark).Requirements structure (
reqstream-usage.md)docs/reqstream/sarifmark-system.yaml→docs/reqstream/system.yaml(standard requiressystem.yamlname)docs/reqstream/ots-software.yaml→docs/reqstream/ots/ots-software.yaml(standard requires OTS requirements inots/subfolder)requirements.yamlincludes to reference new pathsDesign documentation (
design-documentation.md)docs/design/system.mdprose reference from oldsarifmark-system.yamlpath to newsystem.yamlpathReviewMark configuration (
reviewmark-usage.md)SarifMark-Systemreview: updated path todocs/reqstream/system.yaml, removed OTS and Program-unit items that belong in their own dedicated reviewsSarifMark-Designreview set (covers all design documents — required by standard)Type of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.SarifMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes
No source code or test logic changed — this is purely a structural/compliance update to docs, requirements organisation, and review configuration.