Skip to content

Add ReviewMark integration and file review infrastructure#34

Merged
Malcolmnixon merged 6 commits intomainfrom
copilot/update-template-with-reviewmark
Mar 13, 2026
Merged

Add ReviewMark integration and file review infrastructure#34
Malcolmnixon merged 6 commits intomainfrom
copilot/update-template-with-reviewmark

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 13, 2026

Propagates TemplateDotNetTool PRs #58 and #59 into VersionMark: introduces ReviewMark tooling, three VersionMark-specific review-sets, review plan/report document generation, and the code-review-agent.

ReviewMark tool registration

  • .config/dotnet-tools.json — adds demaconsulting.reviewmark v0.1.0-rc.3
  • .versionmark.yaml — adds reviewmark capture entry; upgrades all tool regexes with (?i) and pre-release suffix pattern (?:-[a-zA-Z0-9.]+)?; versionmark is intentionally omitted as the build itself determines the version

Review configuration

  • .reviewmark.yaml (new) — three review-sets scoped to VersionMark's source layout:
    • VersionMark-CLI-ReviewProgram.cs, Context.cs + their tests
    • VersionMark-Utilities-ReviewPathHelpers.cs, Validation.cs, MarkdownFormatter.cs, VersionInfo.cs, VersionMarkConfig.cs + their tests
    • VersionMark-Tests-ReviewIntegrationTests.cs, Runner.cs, AssemblyInfo.cs
  • .gitignore — excludes generated review-plan.md and review-report.md

Document infrastructure

  • docs/reviewplan/, docs/reviewreport/ (new) — Pandoc definition.yaml, title.txt, and introduction.md for each document

CI pipeline (build.yaml)

  • Adds reviewmark to the build-docs version capture command
  • Adds ReviewMark self-validation step alongside other OTS tool validations
  • Adds review plan/report markdown generation, display, HTML (Pandoc), and PDF (Weasyprint) steps

Agent and requirements

  • .github/agents/code-review-agent.md (new) — structured review checklist agent using dotnet reviewmark --elaborate
  • AGENTS.md — adds Code Review Agent to available agents and selection guide
  • requirements.yaml — adds VersionMark-OTS-ReviewMark requirement linked to ReviewMark_ReviewPlanGeneration and ReviewMark_ReviewReportGeneration
  • .cspell.json — adds reviewmark/ReviewMark to word list

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

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

No source code changes — infrastructure and configuration only. versionmark is excluded from .versionmark.yaml tool capture because this is the VersionMark repository itself; the build determines its own version.


💡 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 template with ReviewMark and file reviews Add ReviewMark integration and file review infrastructure Mar 13, 2026
Copilot AI requested a review from Malcolmnixon March 13, 2026 21:58
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI requested a review from Malcolmnixon March 13, 2026 22:13
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 13, 2026 22:14
Copilot AI review requested due to automatic review settings March 13, 2026 22:14
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 ReviewMark-based file review infrastructure to VersionMark (tool registration, review configuration, document templates, CI generation/validation, and agent guidance) to support formal review plan/report generation and traceability.

Changes:

  • Registers ReviewMark as a dotnet tool and adds .reviewmark.yaml review-set configuration + CI steps to validate and generate review plan/report artifacts.
  • Extends VersionMark tool-version capture configuration to include ReviewMark (and VersionMark itself) and updates regex patterns.
  • Adds ReviewMark plan/report Pandoc/WeasyPrint document scaffolding and links ReviewMark into requirements.yaml + agent documentation.

Reviewed changes

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

Show a summary per file
File Description
.config/dotnet-tools.json Adds ReviewMark as a restored local dotnet tool.
.versionmark.yaml Adds versionmark/reviewmark capture entries and updates regexes.
.reviewmark.yaml Introduces review-set definitions and evidence-source configuration.
.github/workflows/build.yaml Runs ReviewMark self-validation; generates/displays plan/report; produces HTML/PDF docs; captures tool versions including ReviewMark.
docs/reviewplan/* Adds Pandoc defaults/title/intro scaffolding for the review plan document.
docs/reviewreport/* Adds Pandoc defaults/title/intro scaffolding for the review report document.
.gitignore Ignores generated review-plan/report markdown outputs.
requirements.yaml Adds an OTS requirement and test IDs for ReviewMark plan/report generation.
.github/agents/code-review-agent.md Adds a structured “Code Review Agent” checklist/process doc.
AGENTS.md Lists “Code Review Agent” and adds selection guidance.
.cspell.json Adds ReviewMark words to the dictionary.

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

Malcolmnixon and others added 2 commits March 13, 2026 18:20
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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