Add the verification document#97
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new verification design document set for Template DotNet Library and updates requirements, review configuration, CI document generation, and tests to support formal verification traceability.
Changes:
- Added
docs/verification/content (intro + system + unit verification design) and wired it into CI document generation + FileAssert. - Refined requirements to improve traceability (more granular requirement IDs and updated linked test names).
- Updated review tooling/standards and test naming/namespaces to align with the new verification artifact model.
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs | Renames system test methods and updates namespace/imports for traceability references. |
| test/DemaConsulting.TemplateDotNetLibrary.Tests/DemoTests.cs | Updates namespace/imports and renames a test to match new requirement/verification wording. |
| src/DemaConsulting.TemplateDotNetLibrary/Demo.cs | Adds remarks clarifying immutability/thread-safety and constructor/method behavior. |
| src/DemaConsulting.TemplateDotNetLibrary/DemaConsulting.TemplateDotNetLibrary.csproj | Updates InternalsVisibleTo to match the test assembly name. |
| docs/verification/title.txt | Adds Pandoc title metadata for the verification document. |
| docs/verification/template-dot-net-library/template-dot-net-library.md | Adds system-level verification strategy and scenario-to-requirement mapping. |
| docs/verification/template-dot-net-library/demo.md | Adds unit-level verification strategy and scenario-to-requirement mapping. |
| docs/verification/introduction.md | Adds verification documentation entry point and artifact-structure guidance. |
| docs/verification/definition.yaml | Adds Pandoc defaults for compiling the verification document. |
| docs/user_guide/introduction.md | Adds an explicit References section. |
| docs/reqstream/template-dot-net-library/template-dot-net-library.yaml | Expands/clarifies system requirements and updates linked test names. |
| docs/reqstream/template-dot-net-library/platform-requirements.yaml | Updates platform requirement evidence links to system integration tests; adds macOS/net481 comment context. |
| docs/reqstream/template-dot-net-library/demo.yaml | Splits Demo unit requirements into more granular, test-linked requirements. |
| docs/reqstream/ots/xunit.yaml | Refines xUnit OTS requirement wording and updates referenced test name. |
| docs/reqstream/ots/reviewmark.yaml | Splits ReviewMark OTS requirements into plan vs report generation. |
| docs/design/template-dot-net-library/template-dot-net-library.md | Updates design doc to reflect xUnit usage and documents API surface/constraints more explicitly. |
| docs/design/template-dot-net-library/demo.md | Replaces template TODOs and clarifies immutability/thread-safety claims. |
| docs/design/introduction.md | Updates companion artifact structure and references; adjusts exclusions and folder layout notes. |
| README.md | Updates testing framework mention to xUnit v3 and improves usage snippet + contributing link. |
| AGENTS.md | Updates repo structure and standards-selection matrix to include verification docs. |
| .reviewmark.yaml | Adds verification files to needs-review and includes verification docs in review-sets. |
| .github/workflows/build.yaml | Adds CI steps to build + FileAssert the verification document outputs. |
| .github/standards/verification-documentation.md | Introduces verification documentation standards. |
| .github/standards/software-items.md | Updates artifact model to include verification design as a required artifact type. |
| .github/standards/reviewmark-usage.md | Updates ReviewMark standards to include verification docs and defines {System}-Verification review-set pattern. |
| .github/standards/design-documentation.md | Updates artifact structure list to include verification design paths. |
| .github/pull_request_template.md | Updates build/lint checklist wording to match repo scripts and docs structure. |
| .github/agents/formal-review.agent.md | Ensures formal-review agent consults verification documentation standards. |
| .fileassert.yaml | Adds FileAssert tests for verification HTML/PDF outputs and updates tag list comment. |
| .cspell.yaml | Adds netstandard to dictionary. |
💡 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 |
…sign Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetLibrary/sessions/c908a0f4-db4b-43bc-991f-0baa03fe92e6 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Contributor
Done in commit 3cf9bad. The two duplicate
|
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
Update agents, then add the verification document and refine via formal reviews.
Type of Change
Related Issues
Closes #
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
pwsh ./lint.ps1(cross-platform)Testing
Documentation
Additional Notes