Skip to content

Add verification documentation, update agents, and switch to xUnit.#46

Merged
Malcolmnixon merged 3 commits into
mainfrom
verification-doc
May 4, 2026
Merged

Add verification documentation, update agents, and switch to xUnit.#46
Malcolmnixon merged 3 commits into
mainfrom
verification-doc

Conversation

@Malcolmnixon
Copy link
Copy Markdown
Member

Pull Request

Description

Add verification documentation, update agents, and switch to xUnit.

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

Copilot AI review requested due to automatic review settings May 4, 2026 16:57
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

This PR updates the repository’s compliance/documentation pipeline by adding a Verification document collection, updating agent/standards content to include verification design, and migrating the C# test suite from MSTest to xUnit v3.

Changes:

  • Migrates DemaConsulting.NuGet.Caching.Tests from MSTest to xUnit v3 (attributes, assertions, and package refs).
  • Introduces a full docs/verification/ document collection (system/unit/OTS verification content + Pandoc definition).
  • Updates CI and document tooling to write build outputs under per-section docs/**/generated/ folders and publish final artifacts under docs/generated/.

Reviewed changes

Copilot reviewed 51 out of 51 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
test/DemaConsulting.NuGet.Caching.Tests/PathHelpersTests.cs Migrates unit tests from MSTest to xUnit [Fact] + xUnit assertions.
test/DemaConsulting.NuGet.Caching.Tests/NuGetCachingTests.cs Migrates integration tests to xUnit and replaces MSTest TestContext usage.
test/DemaConsulting.NuGet.Caching.Tests/NuGetCacheTests.cs Migrates NuGetCache tests to xUnit and updates assertion patterns.
test/DemaConsulting.NuGet.Caching.Tests/DemaConsulting.NuGet.Caching.Tests.csproj Switches test framework packages to xUnit v3 and adjusts TFMs/build settings.
requirements.yaml Swaps MSTest OTS requirements include for xUnit OTS requirements include.
docs/verification/title.txt Adds Pandoc metadata for the new Verification document collection.
docs/verification/ots/xunit.md Adds verification evidence document for xUnit OTS item.
docs/verification/ots/weasyprint.md Adds verification evidence document for WeasyPrint OTS item.
docs/verification/ots/versionmark.md Adds verification evidence document for VersionMark OTS item.
docs/verification/ots/sonarmark.md Adds verification evidence document for SonarMark OTS item.
docs/verification/ots/sarifmark.md Adds verification evidence document for SarifMark OTS item.
docs/verification/ots/reviewmark.md Adds verification evidence document for ReviewMark OTS item.
docs/verification/ots/reqstream.md Adds verification evidence document for ReqStream OTS item.
docs/verification/ots/pandoc.md Adds verification evidence document for Pandoc OTS item.
docs/verification/ots/fileassert.md Adds verification evidence document for FileAssert OTS item.
docs/verification/ots/buildmark.md Adds verification evidence document for BuildMark OTS item.
docs/verification/nuget-caching/path-helpers.md Adds unit-level verification design for PathHelpers.
docs/verification/nuget-caching/nuget-caching.md Adds system-level verification design for NuGetCaching.
docs/verification/nuget-caching/nuget-cache.md Adds unit-level verification design for NuGetCache.
docs/verification/introduction.md Adds the verification document introduction and artifact-structure guidance.
docs/verification/definition.yaml Adds Pandoc defaults definition for building the Verification document.
docs/requirements_report/definition.yaml Updates requirements report inputs to point at generated trace matrix output.
docs/requirements_doc/definition.yaml Updates requirements doc inputs to point at generated ReqStream outputs.
docs/reqstream/ots/xunit.yaml Adds xUnit OTS requirements to replace MSTest.
docs/reqstream/ots/weasyprint.yaml Extends WeasyPrint OTS evidence list to include verification PDF.
docs/reqstream/ots/pandoc.yaml Extends Pandoc OTS evidence list to include verification HTML.
docs/reqstream/ots/mstest.yaml Removes MSTest OTS requirements file.
docs/code_review_report/definition.yaml Updates review report inputs to point at generated ReviewMark output.
docs/code_review_plan/definition.yaml Updates review plan inputs to point at generated ReviewMark output.
docs/code_quality/definition.yaml Updates code quality doc inputs to generated SarifMark/SonarMark outputs.
docs/build_notes/definition.yaml Updates build notes doc inputs to generated BuildMark/VersionMark outputs.
AGENTS.md Updates agent guidance (adds verification docs to structure/standards matrix, clarifies generated folder policy).
.reviewmark.yaml Adds verification docs to needs-review and expands review sets to include verification artifacts and OTS review sets.
.github/workflows/build.yaml Refactors document build outputs into generated/ folders, adds Verification document build stage, updates artifact publishing to docs/generated/*.
.github/standards/verification-documentation.md Adds a new standard defining required structure/content for verification documentation.
.github/standards/technical-documentation.md Updates documentation structure guidance, adds generated-folder exclusions and link/reference rules.
.github/standards/software-items.md Updates the artifact model to include “Verification Design”.
.github/standards/reviewmark-usage.md Updates ReviewMark guidance and paths to generated plan/report outputs; includes verification design in review set patterns.
.github/standards/requirements-principles.md Clarifies what counts as “HOW” vs identity wording in requirements.
.github/standards/reqstream-usage.md Updates ReqStream output paths to docs/**/generated/.
.github/standards/design-documentation.md Adds guidance on references section placement and verbal cross-references.
.github/standards/csharp-testing.md Reworks the C# testing standard from MSTest to xUnit v3-specific guidance.
.github/standards/csharp-language.md Updates C# standard content emphasizing XmlDoc + literate coding.
.github/standards/coding-principles.md Expands documentation requirements and API documentation expectations.
.github/pull_request_template.md Updates local commands/checklist to pwsh ./build.ps1 and pwsh ./lint.ps1.
.github/agents/repo-consistency.agent.md Removes the repo-consistency specialized agent definition.
.github/agents/lint-fix.agent.md Updates markdownlint guidance for handling wide pipe tables.
.github/agents/formal-review.agent.md Adds verification-documentation standard to the formal review prerequisites.
.github/agents/developer.agent.md Minor wording/formatting tweaks to build/test guidance.
.fileassert.yaml Updates file patterns to new generated output locations and adds verification document assertions.
.cspell.yaml Adds xunit to spell-check dictionary.

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

Comment thread test/DemaConsulting.NuGet.Caching.Tests/DemaConsulting.NuGet.Caching.Tests.csproj Outdated
Comment thread docs/reqstream/ots/xunit.yaml
Comment thread docs/verification/introduction.md
Comment thread docs/verification/ots/xunit.md
@Malcolmnixon
Copy link
Copy Markdown
Member Author

@copilot apply changes based on the comments in this thread

Also I think the removal of the net481 framework resulted in:

Error: Only 25 of 26 requirements are satisfied with tests.
Unsatisfied requirements:
  - Caching-PLT-NetStd20

Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/ff9af4be-c986-4bbc-9231-2b41ebaab8ba

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented May 4, 2026

@copilot apply changes based on the comments in this thread

Also I think the removal of the net481 framework r...

Restored the net481 conditional TargetFramework in commit 48bc3bb. This resolves the Caching-PLT-NetStd20 unsatisfied requirement by ensuring net481 test results are produced on Windows CI runs.

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