OTS Verification#98
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds OTS verification evidence documentation and aligns repository standards/review-sets to treat OTS tools as first-class software items in verification, alongside small documentation cleanups.
Changes:
- Added OTS verification evidence documents under
docs/verification/ots/and corresponding ReviewMark review-sets. - Expanded OTS ReqStream requirements to include more granular requirement IDs and test-scenario mappings (including lint/enforcement cases).
- Minor documentation cleanups (including XML doc
<remarks>additions and SarifMark casing fix).
Reviewed changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/DemaConsulting.TemplateDotNetLibrary/Demo.cs | Adds XML <remarks> clarifying constructor validation intent and Prefix property rationale. |
| docs/verification/ots/xunit.md | Adds xUnit OTS verification evidence and scenario-to-requirement mapping. |
| docs/verification/ots/weasyprint.md | Adds WeasyPrint OTS verification evidence based on CI + FileAssert. |
| docs/verification/ots/versionmark.md | Adds VersionMark OTS verification evidence based on CI self-validation + publish outputs. |
| docs/verification/ots/sonarmark.md | Adds SonarMark OTS verification evidence based on self-validation + generated report pipeline. |
| docs/verification/ots/sarifmark.md | Adds SarifMark OTS verification evidence based on self-validation + generated report pipeline. |
| docs/verification/ots/reviewmark.md | Adds ReviewMark OTS verification evidence based on self-validation + generated plan/report pipeline. |
| docs/verification/ots/reqstream.md | Adds ReqStream OTS verification evidence based on self-validation + enforce/report generation. |
| docs/verification/ots/pandoc.md | Adds Pandoc OTS verification evidence based on CI + FileAssert assertions. |
| docs/verification/ots/fileassert.md | Adds FileAssert OTS verification evidence based on self-validation + transitive pipeline use. |
| docs/verification/ots/buildmark.md | Adds BuildMark OTS verification evidence based on self-validation + build-notes generation. |
| docs/verification/introduction.md | Updates verification scope/structure to explicitly include OTS items and their artifact locations. |
| docs/reqstream/ots/xunit.yaml | Splits xUnit requirement into execute/report requirements and maps them to test scenarios. |
| docs/reqstream/ots/weasyprint.yaml | Adds missing verification-PDF scenario to WeasyPrint OTS requirement coverage. |
| docs/reqstream/ots/versionmark.yaml | Adds VersionMark lint requirement with self-validation test mappings. |
| docs/reqstream/ots/sarifmark.yaml | Adds SarifMark enforcement requirement with self-validation test mapping. |
| docs/reqstream/ots/reviewmark.yaml | Expands ReviewMark requirements into multiple capability-specific requirements with test mappings. |
| docs/reqstream/ots/reqstream.yaml | Expands ReqStream requirement test mappings and adds lint requirement. |
| docs/reqstream/ots/pandoc.yaml | Adds missing verification-HTML scenario to Pandoc OTS requirement coverage. |
| docs/reqstream/ots/fileassert.yaml | Updates FileAssert requirement test mappings to align with current self-validation scenarios. |
| docs/reqstream/ots/buildmark.yaml | Expands BuildMark requirement test mappings to include additional self-validation scenarios. |
| docs/design/template-dot-net-library/template-dot-net-library.md | Fixes tool name casing from SARIFMark to SarifMark. |
| .reviewmark.yaml | Adds OTS review-sets and includes verification introduction in relevant review sets. |
| .github/standards/verification-documentation.md | Updates verification documentation standard to include OTS structure and expectations. |
| .github/standards/technical-documentation.md | Minor formatting/clarity updates to documentation standards text. |
| .github/standards/software-items.md | Updates statement to reflect verification design applies to all item types. |
| .github/standards/requirements-principles.md | Minor formatting/clarity updates. |
| .github/standards/design-documentation.md | Minor formatting/clarity updates. |
| .github/standards/csharp-testing.md | Clarifies xUnit v3 dependency requirements and when mocking libs are needed. |
| .github/standards/csharp-language.md | Minor formatting/clarity updates. |
| .github/standards/coding-principles.md | Clarifies “Full Symbol Documentation” principle language. |
| .github/agents/developer.agent.md | Minor formatting/clarity update in agent instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
@copilot apply changes based on the comments in this thread Additionally the build failed with: |
…requirement, remove size claims Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetLibrary/sessions/d3f6b0e1-85a5-41ca-8283-4c71b08de7ad Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Contributor
All applied in aa3aec2:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
Added OTS to verification documentation and performed minor cleanups.
Type of Change
Related Issues
Closes #
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
pwsh ./build.ps1Code Quality
Quality Checks
Please run the following checks before submitting:
pwsh ./lint.ps1Testing
Documentation
Additional Notes