Skip to content

Add the verification document#97

Merged
Malcolmnixon merged 7 commits into
mainfrom
verification-doc
May 1, 2026
Merged

Add the verification document#97
Malcolmnixon merged 7 commits into
mainfrom
verification-doc

Conversation

@Malcolmnixon
Copy link
Copy Markdown
Member

@Malcolmnixon Malcolmnixon commented May 1, 2026

Pull Request

Description

Update agents, then add the verification document and refine via formal reviews.

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

Closes #

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
  • 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: pwsh ./lint.ps1 (cross-platform)

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

Copilot AI review requested due to automatic review settings May 1, 2026 23:05
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

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.

Comment thread .reviewmark.yaml
Comment thread docs/verification/template-dot-net-library/demo.md Outdated
Comment thread docs/verification/template-dot-net-library/demo.md Outdated
@Malcolmnixon
Copy link
Copy Markdown
Member Author

@copilot apply changes based on the comments in this thread

Copilot AI review requested due to automatic review settings May 1, 2026 23:28
@Malcolmnixon Malcolmnixon review requested due to automatic review settings May 1, 2026 23:28
Copy link
Copy Markdown
Contributor

Copilot AI commented May 1, 2026

@copilot apply changes based on the comments in this thread

Done in commit 3cf9bad. The two duplicate Template-Demo-Prefix scenario sections have been removed:

  • The Prefix With Custom Construction Returns Custom Prefix scenario was consolidated into the Template-Demo-AcceptCustomPrefix scenario (expanded description now covers both the constructor accepting a custom prefix and the Prefix property exposing it).
  • The duplicate Default Constructor Sets Default Prefix scenario was removed; the single definition under Template-Demo-DefaultPrefix remains, and the coverage table continues to reference it for Template-Demo-Prefix as well.

@Malcolmnixon Malcolmnixon merged commit ab9f405 into main May 1, 2026
6 checks passed
@Malcolmnixon Malcolmnixon deleted the verification-doc branch May 1, 2026 23:51
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