Skip to content

chore: Apply TemplateDotNetTool consistency updates (PRs #57–#77)#109

Merged
Malcolmnixon merged 6 commits intomainfrom
copilot/bring-in-recent-template-changes
Mar 30, 2026
Merged

chore: Apply TemplateDotNetTool consistency updates (PRs #57–#77)#109
Malcolmnixon merged 6 commits intomainfrom
copilot/bring-in-recent-template-changes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 30, 2026

Pull Request

Description

Pulls in recent template evolution from TemplateDotNetTool (PRs #57#77), introducing a formal .github/standards/ layer and three new specialized agents, plus linting/tooling improvements across the board.

New: .github/standards/ — shared standards documents

  • csharp-language.md — C# literate programming, XML docs, DI conventions
  • csharp-testing.md — MSTest AAA pattern, naming, anti-patterns
  • reqstream-usage.md — ReqStream usage adapted for VHDLTest (includes ghdl@/nvc@ source filters)
  • reviewmark-usage.md — ReviewMark file-review workflow
  • software-items.md — System/Subsystem/Unit/OTS categorization
  • technical-documentation.md — Docs structure, Pandoc, README best practices

New agents

  • developer.agent.md — General-purpose developer agent referencing standards files
  • implementation.agent.md — Orchestrator agent with formal state-machine workflow
  • quality.agent.md — QA agent grading work against standards

Updated agents

  • code-review.agent.md, repo-consistency.agent.md — Aligned to new simplified template format

AGENTS.md

  • Added Standards Application section, Agent Delegation Guidelines, and entries for the three new agents

Linting / tooling

  • lint.sh / lint.bat: --silent for npm, --quiet for pip, --quiet + cpp,hpp,h extensions for cspell, removed explicit solution name from dotnet format
  • .markdownlint-cli2.yaml: added noBanner: true, noProgress: true, .agent-logs/** to ignores
  • .yamllint.yaml, .cspell.yaml, .gitignore: added .agent-logs/ exclusions
  • .cspell.yaml: added sonarmark/SonarMark and versionmark/VersionMark (consistent with existing buildmark, sarifmark, reqstream, reviewmark entries)

Documentation restructure

  • Renamed docs/guide/docs/user_guide/ to align with the standards layout documented in technical-documentation.md
  • Renamed docs/guide/guide.mddocs/user_guide/introduction.md to match the standard Pandoc document structure
  • Updated all references in docs/user_guide/definition.yaml, .github/workflows/build.yaml, and AGENTS.md

Requirements restructure

  • Split monolithic requirements.yaml into separate files under docs/reqstream/ per reqstream-usage.md standards, categorized by software item type:
    • docs/reqstream/vhdltest-system.yaml — system-level requirements (CLI, Test Execution, Validation — 11 requirements)
    • docs/reqstream/platform-requirements.yaml — platform support requirements (6 requirements, source filters preserved)
    • docs/reqstream/subsystem-simulators.yaml — simulator subsystem requirements (6 requirements, ghdl@/nvc@ filters preserved)
    • docs/reqstream/ots-mstest.yaml, ots-reqstream.yaml, ots-buildmark.yaml, ots-versionmark.yaml, ots-sarifmark.yaml, ots-sonarmark.yaml — one file per OTS tool
  • Root requirements.yaml updated to includes-only (header comment and source filter documentation preserved)

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.VHDLTest --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 production code changes — this PR is purely agent/standards infrastructure, tooling, and requirements organization. All quality checks (dotnet build, lint.sh) pass with zero warnings.


⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.

Copilot AI and others added 3 commits March 30, 2026 03:21
- Add noBanner/noProgress to .markdownlint-cli2.yaml; remove MD024 block; add .agent-logs ignore
- Add .agent-logs/ to .yamllint.yaml ignore list
- Add .agent-logs/** to .cspell.yaml ignorePaths
- Update lint.sh and lint.bat: silent npm/pip installs, --quiet cspell flag, add cpp/hpp/h extensions, remove solution name from dotnet format
- Add .agent-logs/ to .gitignore
- Add .github/standards/ directory with csharp-language, csharp-testing, reqstream-usage (VHDLTest-adapted), reviewmark-usage, software-items, technical-documentation
- Add developer, implementation, quality agent files from template
- Update code-review.agent.md to new template format (no tools: frontmatter, formal review steps, reporting)
- Update repo-consistency.agent.md to new template format with VHDLTest-specific description
- Update AGENTS.md with Standards Application section, Agent Delegation Guidelines, new agent entries, and updated Custom Agents list

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Add cross-reference note so readers know project-specific agents
(requirements, software-developer, etc.) are documented in the
Custom Agents section.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
…dings

The guide.md legitimately uses duplicate headings under different parent
sections (e.g., 'Purpose' and 'CI/CD Integration' at different levels).
This is a valid VHDLTest-specific customization that was incorrectly
removed during template alignment.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update project with recent template changes chore: Apply TemplateDotNetTool consistency updates (PRs #57–#77) Mar 30, 2026
Copilot AI requested a review from Malcolmnixon March 30, 2026 03:27
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 30, 2026 03:28
Copilot AI review requested due to automatic review settings March 30, 2026 03:28
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 pulls consistency updates from TemplateDotNetTool into VHDLTest by adding a formal .github/standards/ documentation layer, introducing new workflow-based agents, and tightening/silencing parts of the lint/tooling output.

Changes:

  • Added standards documents under .github/standards/ to guide C#, testing, ReqStream, ReviewMark, software item categorization, and documentation practices.
  • Added new specialized agents (developer, implementation, quality) and updated existing agent definitions/docs.
  • Updated lint scripts and linter configs to reduce noise and exclude .agent-logs/ from checks and git tracking.

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
lint.sh Silences npm/pip output, expands cspell extensions, and runs dotnet format without explicit solution path.
lint.bat Windows equivalent of lint script updates (silent npm/pip, cspell extensions, dotnet format default).
AGENTS.md Documents standards application and delegation to new workflow agents.
.yamllint.yaml Excludes .agent-logs/ from yamllint.
.markdownlint-cli2.yaml Disables banner/progress and excludes .agent-logs/**.
.gitignore Ignores .agent-logs/.
.cspell.yaml Excludes .agent-logs/** from cspell.
.github/standards/csharp-language.md Adds C# coding standards document.
.github/standards/csharp-testing.md Adds MSTest/AAA/testing standards document.
.github/standards/reqstream-usage.md Adds ReqStream usage/standards guidance.
.github/standards/reviewmark-usage.md Adds ReviewMark workflow/standards guidance.
.github/standards/software-items.md Adds software item categorization guidance.
.github/standards/technical-documentation.md Adds documentation structure and markdown standards guidance.
.github/agents/repo-consistency.agent.md Updates repo-consistency agent instructions and reporting location.
.github/agents/code-review.agent.md Updates code-review agent workflow and reporting location.
.github/agents/developer.agent.md Adds new developer agent definition and reporting template.
.github/agents/implementation.agent.md Adds new implementation orchestrator agent definition.
.github/agents/quality.agent.md Adds new quality assessment agent definition and report template.

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

Comment thread .github/agents/repo-consistency.agent.md
Comment thread .github/agents/developer.agent.md
Comment thread .github/agents/implementation.agent.md
Comment thread .github/agents/quality.agent.md
Comment thread .github/standards/technical-documentation.md
Comment thread .github/standards/reqstream-usage.md
Comment thread .github/agents/code-review.agent.md
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 30, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

…e.md standards

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/7367bc6d-a123-41f1-b703-ac7a79459a3d

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 30, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@Malcolmnixon Malcolmnixon merged commit 78c0f1a into main Mar 30, 2026
26 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/bring-in-recent-template-changes branch March 30, 2026 14:18
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