chore: Apply TemplateDotNetTool consistency updates (PRs #57–#77)#109
chore: Apply TemplateDotNetTool consistency updates (PRs #57–#77)#109Malcolmnixon merged 6 commits intomainfrom
Conversation
- 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>
There was a problem hiding this comment.
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.
…on.md Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/d2fc7bd2-3c74-40ce-bf49-3b92ab4da1bc Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
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:
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>
|
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:
If you need me to access, download, or install something from one of these locations, you can either:
|
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 documentscsharp-language.md— C# literate programming, XML docs, DI conventionscsharp-testing.md— MSTest AAA pattern, naming, anti-patternsreqstream-usage.md— ReqStream usage adapted for VHDLTest (includesghdl@/nvc@source filters)reviewmark-usage.md— ReviewMark file-review workflowsoftware-items.md— System/Subsystem/Unit/OTS categorizationtechnical-documentation.md— Docs structure, Pandoc, README best practicesNew agents
developer.agent.md— General-purpose developer agent referencing standards filesimplementation.agent.md— Orchestrator agent with formal state-machine workflowquality.agent.md— QA agent grading work against standardsUpdated agents
code-review.agent.md,repo-consistency.agent.md— Aligned to new simplified template formatAGENTS.mdLinting / tooling
lint.sh/lint.bat:--silentfor npm,--quietfor pip,--quiet+cpp,hpp,hextensions for cspell, removed explicit solution name fromdotnet format.markdownlint-cli2.yaml: addednoBanner: true,noProgress: true,.agent-logs/**to ignores.yamllint.yaml,.cspell.yaml,.gitignore: added.agent-logs/exclusions.cspell.yaml: addedsonarmark/SonarMarkandversionmark/VersionMark(consistent with existingbuildmark,sarifmark,reqstream,reviewmarkentries)Documentation restructure
docs/guide/→docs/user_guide/to align with the standards layout documented intechnical-documentation.mddocs/guide/guide.md→docs/user_guide/introduction.mdto match the standard Pandoc document structuredocs/user_guide/definition.yaml,.github/workflows/build.yaml, andAGENTS.mdRequirements restructure
requirements.yamlinto separate files underdocs/reqstream/perreqstream-usage.mdstandards, 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 toolrequirements.yamlupdated to includes-only (header comment and source filter documentation preserved)Type of Change
Related Issues
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.VHDLTest --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 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.