Skip to content

Add ReviewMark integration (review plan, review report, multi-set config)#69

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/update-project-with-template-changes
Mar 14, 2026
Merged

Add ReviewMark integration (review plan, review report, multi-set config)#69
Malcolmnixon merged 3 commits intomainfrom
copilot/update-project-with-template-changes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 14, 2026

Brings SarifMark in line with TemplateDotNetTool PRs #58 and #59 by integrating ReviewMark for formal file review coverage and currency tracking.

ReviewMark configuration

  • .reviewmark.yaml — three review sets pairing source with tests: SarifMark-CLI-Review (Program.cs, Context.cs + ProgramTests.cs, ContextTests.cs), SarifMark-Core-Review (PathHelpers.cs, Validation.cs, SarifResult.cs, SarifResults.cs + PathHelpersTests.cs, SarifResultsTests.cs), SarifMark-Integration-Review (IntegrationTests.cs, Runner.cs, AssemblyInfo.cs)
  • .config/dotnet-tools.json — adds demaconsulting.reviewmark v0.1.0-rc.3
  • .versionmark.yaml — adds reviewmark entry; applies pre-release regex ((?:-[a-zA-Z0-9.]+)?) to all tool patterns
  • .gitignore — excludes generated review-plan.md and review-report.md

Review plan / report documents

  • docs/reviewplan/, docs/reviewreport/ — Pandoc definition, title, and introduction for each document
  • .github/workflows/build.yaml — ReviewMark self-validation, plan and report generation (markdown → HTML → PDF) added to build-docs job; reviewmark added to version capture

Agent and requirements

  • .github/agents/code-review-agent.md — agent instructions for performing formal reviews against the review-set IDs
  • AGENTS.md — adds Code Review Agent entry and Perform a formal file review → Code Review Agent routing rule
  • requirements.yamlSarifMark-OTS-ReviewMark OTS requirement linked to ReviewMark_ReviewPlanGeneration and ReviewMark_ReviewReportGeneration self-validation tests
  • .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
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.SarifMark --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 .
  • Self-validation passes:
    dotnet run --project src/DemaConsulting.SarifMark --configuration Release --framework net10.0 --no-build -- --validate

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.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…et config)

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update project with latest updates from template and formal reviews Add ReviewMark integration (review plan, review report, multi-set config) Mar 14, 2026
Copilot AI requested a review from Malcolmnixon March 14, 2026 18:42
…to SarifMark-Integration-Review

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 14, 2026 18:50
Copilot AI review requested due to automatic review settings March 14, 2026 18:50
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

Integrates ReviewMark into SarifMark’s compliance/documentation pipeline to produce formal file review coverage and currency artifacts, aligning the repo with TemplateDotNetTool patterns.

Changes:

  • Added ReviewMark tool installation, version tracking, and CI self-validation.
  • Introduced .reviewmark.yaml with multiple review-sets and generated Review Plan / Review Report documentation inputs.
  • Linked ReviewMark execution to OTS requirements traceability via new requirements.yaml entries and CI-generated artifacts.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
requirements.yaml Adds OTS requirement mapping ReviewMark execution to self-validation TRX evidence.
docs/reviewplan/title.txt Adds Pandoc title metadata for the Review Plan document.
docs/reviewplan/introduction.md Adds Review Plan introduction/boilerplate content.
docs/reviewplan/definition.yaml Adds Pandoc defaults definition for generating Review Plan output.
docs/reviewreport/title.txt Adds Pandoc title metadata for the Review Report document.
docs/reviewreport/introduction.md Adds Review Report introduction/boilerplate content.
docs/reviewreport/definition.yaml Adds Pandoc defaults definition for generating Review Report output.
AGENTS.md Registers the Code Review Agent and routes “formal file review” tasks to it.
.versionmark.yaml Adds ReviewMark capture and updates tool regexes to accept optional pre-release suffixes.
.reviewmark.yaml Introduces ReviewMark configuration (needs-review patterns, evidence source, review-sets).
.gitignore Ignores generated ReviewMark markdown outputs under docs/reviewplan/ and docs/reviewreport/.
.github/workflows/build.yaml Adds ReviewMark validation plus review plan/report generation and PDF/HTML build steps.
.github/agents/code-review-agent.md Adds agent instructions for conducting formal review-set reviews using ReviewMark.
.cspell.json Adds ReviewMark-related terms to the spell-check dictionary.
.config/dotnet-tools.json Adds demaconsulting.reviewmark as a restored dotnet tool.

💡 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