Skip to content

Rename self-validation tests for clarity#18

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/update-reviewmark-names
Mar 11, 2026
Merged

Rename self-validation tests for clarity#18
Malcolmnixon merged 2 commits intomainfrom
copilot/update-reviewmark-names

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 11, 2026

The self-validation test names ReviewMark_DefinitionPlan, ReviewMark_DefinitionReport, and ReviewMark_Dir don't clearly communicate what functionality they prove. Rename them to follow the ReviewMark_Functionality convention with names that are self-explanatory.

Changes

  • Validation.cs — update the three test ID strings passed to RunValidationTest:
    • ReviewMark_DefinitionPlanReviewMark_ReviewPlanGeneration
    • ReviewMark_DefinitionReportReviewMark_ReviewReportGeneration
    • ReviewMark_DirReviewMark_WorkingDirectoryOverride
  • requirements.yaml — update all 24 references (bare names + windows@, ubuntu@, macos@, dotnet8.x@, dotnet9.x@, dotnet10.x@ filtered variants)
  • README.md and docs/guide/guide.md — update sample output blocks and test description lists

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.ReviewMark --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

Self-validation output after the rename:

✓ ReviewMark_VersionDisplay - Passed
✓ ReviewMark_HelpDisplay - Passed
✓ ReviewMark_ReviewPlanGeneration - Passed
✓ ReviewMark_ReviewReportGeneration - Passed
✓ ReviewMark_IndexScan - Passed
✓ ReviewMark_WorkingDirectoryOverride - Passed
✓ ReviewMark_Enforce - Passed
✓ ReviewMark_Elaborate - Passed

Total Tests: 8
Passed: 8
Failed: 0

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update self-validation names for ReviewMark functionality Rename self-validation tests for clarity Mar 11, 2026
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 11, 2026 19:31
Copilot AI review requested due to automatic review settings March 11, 2026 19:31
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 improves the clarity of ReviewMark’s self-validation output by renaming three self-validation test IDs to more explicitly describe the functionality they validate, and then updating all downstream references in requirements and documentation.

Changes:

  • Renamed three self-validation test IDs in Validation.cs to follow the ReviewMark_<Functionality> convention.
  • Updated requirements.yaml references (including platform/runtime-filtered variants) to match the new IDs.
  • Updated sample validation output and test description lists in README.md and docs/guide/guide.md.

Reviewed changes

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

File Description
src/DemaConsulting.ReviewMark/Validation.cs Renames the three self-validation test ID strings used when reporting validation results.
requirements.yaml Updates requirement-to-test mappings and platform/runtime-qualified test references to the new IDs.
docs/guide/guide.md Updates documentation sample output and test descriptions to the new validation test IDs.
README.md Updates README sample output and test descriptions to the new validation test IDs.

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

You can also share your feedback on Copilot code review. Take the survey.

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