Skip to content

Add ReviewMark formal code review system from TemplateDotNetLibrary template#117

Merged
Malcolmnixon merged 5 commits intomainfrom
copilot/update-template-with-latest-changes
Mar 12, 2026
Merged

Add ReviewMark formal code review system from TemplateDotNetLibrary template#117
Malcolmnixon merged 5 commits intomainfrom
copilot/update-template-with-latest-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 12, 2026

Syncs with the latest TemplateDotNetLibrary template by adopting the ReviewMark continuous compliance feature, defining two logical review-sets appropriate for this project.

Review-Sets

  • TestResults-Modelsrc/DemaConsulting.TestResults/*.cs (core model classes)
  • TestResults-Serializationsrc/DemaConsulting.TestResults/IO/**/*.cs (TRX/JUnit serializers)

Changes

Tool & Configuration

  • .reviewmark.yaml — defines the two review-sets and evidence source (reviews branch root)
  • .config/dotnet-tools.json — adds demaconsulting.reviewmark v0.1.0-rc.3
  • .versionmark.yaml — adds reviewmark capture; updates all version regexes to support pre-release semver strings (e.g. 0.1.0-rc.3)

CI/CD (build.yaml)

  • ReviewMark self-validation step
  • Review Plan and Review Report generation (Pandoc HTML → WeasyPrint PDF)

Documentation Scaffolding

  • docs/reviewplan/ and docs/reviewreport/ — Pandoc definition files, introductions, and PDF title metadata

Agent Infrastructure

  • .github/agents/code-review-agent.md — new agent for elaborating review-sets and producing structured review reports
  • AGENTS.md — adds Code Review Agent to available agents and selection guide
  • .github/agents/repo-consistency-agent.md — adds template evolution tracking guidance

Housekeeping

  • .gitignore — excludes generated review markdown outputs and versionmark-*.json
  • .cspell.json — adds reviewmark, ReviewMark, reviewplan, reviewreport

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
  • 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

The reviews branch (evidence store for ReviewMark enforcement) does not yet exist — the --enforce flag is not set in the pipeline until that branch is populated with review evidence PDFs and an index.json at the branch root. The evidence source URL points to https://raw.githubusercontent.com/demaconsulting/TestResults/reviews/index.json.


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

- Add .reviewmark.yaml with TestResults-Model and TestResults-Serialization review-sets
- Add demaconsulting.reviewmark v0.1.0-rc.3 to dotnet tools
- Add reviewmark tool capture in .versionmark.yaml (pre-release version regex support)
- Add .github/agents/code-review-agent.md
- Update AGENTS.md with Code Review Agent
- Update repo-consistency-agent.md with template tracking guidance
- Update build.yaml with ReviewMark steps, plan/report generation, and PDF steps
- Add docs/reviewplan/ and docs/reviewreport/ definition files
- Update .gitignore and .cspell.json

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update template with latest changes and evaluate review sets Add ReviewMark formal code review system from TemplateDotNetLibrary template Mar 12, 2026
Copilot AI requested a review from Malcolmnixon March 12, 2026 17:37
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI requested a review from Malcolmnixon March 12, 2026 18:09
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 12, 2026 18:35
Copilot AI review requested due to automatic review settings March 12, 2026 18:35
Copy link
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

Introduces the ReviewMark “formal code review” compliance system into the repo (configuration, CI generation of review plan/report documents, and supporting agent/docs scaffolding).

Changes:

  • Adds ReviewMark tool/configuration and expands VersionMark capture to include ReviewMark (and pre-release tool versions).
  • Updates CI workflow to self-validate ReviewMark and generate Review Plan/Report artifacts (Markdown → HTML → PDF).
  • Adds documentation scaffolding and agent guidance for conducting/storing formal file reviews.

Reviewed changes

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

Show a summary per file
File Description
docs/reviewreport/title.txt Adds Pandoc metadata for the Review Report PDF.
docs/reviewreport/introduction.md Adds Review Report introduction content.
docs/reviewreport/definition.yaml Adds Pandoc defaults for generating Review Report HTML/PDF.
docs/reviewplan/title.txt Adds Pandoc metadata for the Review Plan PDF.
docs/reviewplan/introduction.md Adds Review Plan introduction content.
docs/reviewplan/definition.yaml Adds Pandoc defaults for generating Review Plan HTML/PDF.
AGENTS.md Registers the new Code Review Agent in the project agent guide.
.versionmark.yaml Updates tool version regexes to support pre-release versions; adds ReviewMark capture.
.reviewmark.yaml Adds ReviewMark review-set definitions and evidence-source configuration.
.gitignore Ignores generated ReviewMark markdown outputs, VersionMark captures, and agent reports.
.github/workflows/build.yaml Adds ReviewMark validation + plan/report generation + HTML/PDF document generation steps.
.github/agents/repo-consistency-agent.md Adds guidance for tracking upstream template evolution.
.github/agents/code-review-agent.md Adds a new agent spec for performing structured formal file reviews.
.cspell.json Adds ReviewMark-related terms to the spell-check dictionary.
.config/dotnet-tools.json Adds demaconsulting.reviewmark as a local dotnet tool dependency.

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…anch root

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon merged commit 4c5d9d4 into main Mar 12, 2026
8 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-template-with-latest-changes branch March 12, 2026 19:13
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