Skip to content

Add NamespaceDoc for DemaConsulting.TestResults and IO namespaces - #167

Merged
Malcolmnixon merged 3 commits into
mainfrom
copilot/add-namespacedoc-for-dematconsulting-testresults
Jul 2, 2026
Merged

Add NamespaceDoc for DemaConsulting.TestResults and IO namespaces#167
Malcolmnixon merged 3 commits into
mainfrom
copilot/add-namespacedoc-for-dematconsulting-testresults

Conversation

Copilot AI commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Pull Request

Description

Adds NamespaceDoc classes to the DemaConsulting.TestResults and DemaConsulting.TestResults.IO namespaces so ApiMark generates rich namespace-level pages in the packaged API documentation. Both files are documentation scaffolding (internal static class NamespaceDoc) rather than software items, so they are tracked in the Purpose review-set rather than any unit-level review-set.

  • src/DemaConsulting.TestResults/NamespaceDoc.cs — covers the two-layer model/IO architecture, all three model types (TestResults, TestResult, TestOutcome/TestOutcomeExtensions), build-and-serialize and read-and-inspect examples, default value guarantees, and thread-safety contract.
  • src/DemaConsulting.TestResults/IO/NamespaceDoc.cs — covers all three serializer types (TrxSerializer, JUnitSerializer, Serializer) and TestResultFormat, guidance on when to use each serializer, examples for auto-detection, format identification, and explicit TRX/JUnit round-trips, JUnit round-trip loss caveats, and thread-safety contract.
  • .reviewmark.yaml — both NamespaceDoc.cs files added to the Purpose review-set.

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

Pre-Submission Checklist

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

  • 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

NamespaceDoc is a documentation-only convention; the class body is empty and the type is internal, so it has no effect on the public API surface.

@Malcolmnixon
Malcolmnixon marked this pull request as ready for review July 2, 2026 20:06
Copilot AI review requested due to automatic review settings July 2, 2026 20:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 adds NamespaceDoc scaffolding types so ApiMark can generate namespace-level API documentation pages for the core DemaConsulting.TestResults namespace and the DemaConsulting.TestResults.IO namespace, and updates ReviewMark to include these files in the Purpose review-set.

Changes:

  • Added NamespaceDoc for DemaConsulting.TestResults with model/IO architecture description, usage examples, and behavioral contracts.
  • Added NamespaceDoc for DemaConsulting.TestResults.IO documenting the serializers, format detection, examples, and known JUnit round-trip limitations.
  • Updated .reviewmark.yaml to include both NamespaceDoc.cs files in the Purpose review-set.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/DemaConsulting.TestResults/NamespaceDoc.cs Adds namespace-level XML docs and examples for the in-memory model layer and its usage/contracts.
src/DemaConsulting.TestResults/IO/NamespaceDoc.cs Adds namespace-level XML docs and examples for TRX/JUnit serializers and format detection behavior.
.reviewmark.yaml Tracks the new documentation-only NamespaceDoc files under the Purpose review-set.

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

Comment thread src/DemaConsulting.TestResults/NamespaceDoc.cs Outdated
Comment thread src/DemaConsulting.TestResults/IO/NamespaceDoc.cs Outdated
Copilot AI requested review from Copilot and removed request for Copilot July 2, 2026 20:16
Copilot AI requested a review from Malcolmnixon July 2, 2026 20:16
@Malcolmnixon
Malcolmnixon merged commit 8367ffb into main Jul 2, 2026
24 of 26 checks passed
@Malcolmnixon
Malcolmnixon deleted the copilot/add-namespacedoc-for-dematconsulting-testresults branch July 2, 2026 21:43
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