Skip to content

Align self-validation output with TemplateDotNetTool formatting#119

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/check-formatting-documentation
Mar 4, 2026
Merged

Align self-validation output with TemplateDotNetTool formatting#119
Malcolmnixon merged 2 commits intomainfrom
copilot/check-formatting-documentation

Conversation

Copy link
Contributor

Copilot AI commented Mar 4, 2026

Pull Request

Description

Self-validation console output used friendly descriptions (Requirements Processing Test - PASSED) instead of actual test names, inconsistent with the pattern established in TemplateDotNetTool#51.

Validation.cs

  • Print actual test names in pass/fail lines: ✓ ReqStream_RequirementsProcessing - Passed
  • Consistent title-case Passed/Failed throughout (including HandleTestException)

docs/guide/guide.md

  • Renamed ### Running Self-Validation### Running Validation
  • Added ### Validation Report subsection with example output using actual test names
  • Added ### Validation Tests subsection listing each test with a one-line proof statement

README.md

  • Added ## Self Validation section with example report block, per-test descriptions, link to User Guide, and exit-code failure note

ProgramTests.cs

  • Updated assertions to match new output format

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

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
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.ReqStream --configuration Release --framework net10.0
    --no-build -- --validate
  • 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:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

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

Validation output now matches the console/log/README/guide example exactly:

✓ ReqStream_RequirementsProcessing - Passed
✓ ReqStream_TraceMatrix - Passed
✓ ReqStream_ReportExport - Passed
✓ ReqStream_TagsFiltering - Passed
✓ ReqStream_EnforcementMode - Passed

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

… formatting

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Check consistency of self-validation output with template project Align self-validation output with TemplateDotNetTool formatting Mar 4, 2026
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 4, 2026 00:55
@Malcolmnixon Malcolmnixon merged commit 3f7e80b into main Mar 4, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/check-formatting-documentation branch March 4, 2026 01:05
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.

2 participants