Sync template files and install ReviewMark as local dotnet tool#51
Sync template files and install ReviewMark as local dotnet tool#51Malcolmnixon merged 2 commits intomainfrom
Conversation
- Binary-copy AGENTS.md, .github/agents/*.md, .github/standards/*.md from TemplateDotNetTool - Add new coding-principles.md and testing-principles.md standards files - Update lint.sh and lint.bat with dotnet linting section (reqstream, versionmark, reviewmark lint + dotnet format) - Add demaconsulting.reviewmark 1.0.0 to .config/dotnet-tools.json - Remove global ReviewMark install from build-docs job in build.yaml - Add dotnet reviewmark self-validation step to build-docs job - Use dotnet reviewmark in build-docs (instead of global reviewmark) - Add reviewmark to versionmark capture in build-docs Agent-Logs-Url: https://github.com/demaconsulting/ReviewMark/sessions/bbde2eca-8872-4bba-bb91-bf6caea974b4 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates repository standards/tooling to align with the TemplateDotNetTool template and shifts ReviewMark consumption in CI from a global tool install to a local tool manifest (.config/dotnet-tools.json), keeping global installs limited to integration-test scenarios.
Changes:
- Expanded
lint.sh/lint.batto restore .NET tools and run ReqStream/VersionMark/ReviewMark linting plusdotnet format --verify-no-changes --no-restore. - Updated
build-docsworkflow to use locally-restored ReviewMark (dotnet reviewmark), added ReviewMark self-validation, and captured its version via VersionMark. - Synced/extended agent + standards documentation, adding new universal coding/testing principle standards and front-matter metadata.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
lint.sh |
Adds Puppeteer skip-download env var; restores .NET tools; runs ReqStream/VersionMark/ReviewMark lint; updates dotnet format invocation. |
lint.bat |
Windows equivalent updates: improved section abort handling; sets Puppeteer skip-download; restores .NET tools; runs .NET linting + formatting. |
AGENTS.md |
Updates standards list and template placeholders (<project> → {project}), adding new coding/testing standards. |
.github/workflows/build.yaml |
Removes global ReviewMark install from build-docs; uses dotnet tool restore; adds ReviewMark validation; switches report generation to dotnet reviewmark; includes ReviewMark in captured tool versions. |
.github/standards/testing-principles.md |
New universal testing principles standard (dependency boundaries, AAA, quality gates). |
.github/standards/technical-documentation.md |
Adds front matter and clarifies reference-section rules (external specs only). |
.github/standards/software-items.md |
Adds clarifications on subsystem/unit definitions (e.g., methods aren’t separate units). |
.github/standards/reviewmark-usage.md |
Adds front matter and explicit prerequisite standard(s). |
.github/standards/reqstream-usage.md |
Adds front matter, prerequisite standard(s), and clarifies downward requirement linking language. |
.github/standards/design-documentation.md |
Adds front matter, prerequisites, and clarifies design scope excludes test artifacts. |
.github/standards/csharp-testing.md |
Adds front matter + prerequisite standards; removes duplicated AAA/coverage narrative now covered by shared testing principles. |
.github/standards/csharp-language.md |
Adds front matter; points to new universal coding principles; simplifies to examples/formatting/quality checks. |
.github/standards/coding-principles.md |
New universal coding principles standard (literate coding, architecture principles, quality gates). |
.github/agents/quality.agent.md |
Adds testing compliance checks re: hierarchy boundaries; moves “Result” semantics guidance to end of document. |
.config/dotnet-tools.json |
Adds demaconsulting.reviewmark pinned to v1.0.0 as a local .NET tool. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot The build-docs job is failing with the following error: The .versionmark.yaml file needs a reviewmark entry just like the other dotnet tools - the template does it as follows: # ReviewMark (DemaConsulting.ReviewMark from dotnet tool list)
reviewmark:
command: dotnet tool list
regex: '(?i)demaconsulting\.reviewmark\s+(?<version>\d+\.\d+\.\d+(?:-[a-zA-Z0-9.]+)?)' |
Agent-Logs-Url: https://github.com/demaconsulting/ReviewMark/sessions/57e4e327-bab7-43aa-ba4d-75e1a88c77df Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
... Added the |
Brings in updated agent/standards/lint files from
TemplateDotNetTooland changes the policy so ReviewMark is installed locally via.config/dotnet-tools.json(released v1.0.0), with global install restricted to integration-test jobs only.Description
Template file sync (binary copies)
AGENTS.md— updated standards list; addscoding-principles.mdandtesting-principles.md;<project>→{project}.github/agents/*.md— all 5 agents updated;quality.agent.mdgains two Testing Compliance items for hierarchy boundary enforcement.github/standards/coding-principles.md— new file: universal literate coding, architecture, and quality gate standards.github/standards/testing-principles.md— new file: universal test dependency boundaries, AAA pattern, and quality gates.github/standards/csharp-language.md— now requirescoding-principles.md.github/standards/csharp-testing.md— now requirestesting-principles.mdandcsharp-language.mdlint.sh/lint.bat— expanded with full dotnet linting section:dotnet tool restore,dotnet reqstream --lint,dotnet versionmark --lint,dotnet reviewmark --lint,dotnet format --verify-no-changes --no-restoreReviewMark local tool
.config/dotnet-tools.json— addsdemaconsulting.reviewmarkv1.0.0.versionmark.yaml— addsreviewmarktool entry so VersionMark can capture its version in thebuild-docsjobbuild.yamlbuild-docsjob:dotnet reviewmark --validateself-validation step alongside other OTS toolsreviewmark→dotnet reviewmarkfor plan/report generationreviewmarktoversionmark --capturetool listintegration-testjob — unchanged; still installs the newly-built package globally for integration testingType of Change
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
No source code or test changes — CI/tooling/documentation only. The
build-docsjob now uses the released ReviewMark from the local tool manifest rather than the version being built, consistent with how all other OTS tools in that job are consumed.