chore: binary-copy updated files from TemplateDotNetTool template and apply new standards#116
Conversation
Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/6f37c143-b93f-432a-8548-928e003cca48 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot The .github/standards for this repository have just been updated. Please read the standards, then review the following and update to the new standards:
|
… update reviewmark Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/ae53f0b1-c7eb-4f18-8329-cc69759ebd86 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Done in commit 3bd7183. Here's what was updated to align with the new standards:
No pandoc |
|
@copilot Odd.. the docs/design pandoc document has no title.txt or definition.yaml file. Please make them and have the build.yaml pipeline actually compile the design document. Please check that subsystem-requirements are tested by subsystem-tests; and that subsystem review-sets consist of the subsystem-requirements, subsystem-design, and subsystem-test-suite. Please check that unit review-sets consist of unit-requirements, unit-design, unit-code, and unit-test-suite. Subsystem requirements should 'children' link to the unit-requirements used to implement the subsystem requirement functionality. |
…t file fixes Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/e44e444a-0817-49a1-a19b-3b9e0d9bcb92 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Done in commit cb2b84e. Here's a summary of what was addressed: Design doc pandoc files: Created Subsystem requirements → children links: Added
Review-set fixes: Added All subsystem review-sets consist of: subsystem requirements + subsystem design + subsystem test suite. All unit review-sets consist of: unit requirements + unit design + unit code + unit tests. |
…its own review Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/2d712b16-586e-42d5-9b29-269c27e704e9 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR syncs VHDLTest with updated TemplateDotNetTool/Continuous Compliance standards by restructuring requirements/design documentation under system-scoped folders, updating ReviewMark review-set IDs/paths, and extending CI to publish a consolidated Design document.
Changes:
- Re-home ReqStream sources under
docs/reqstream/vhdltest/and updaterequirements.yamlincludes accordingly. - Add/refresh design documentation under
docs/design/vhdltest/and add Pandoc/WeasyPrint generation for a “VHDLTest Design” HTML/PDF artifact. - Update lint scripts, agent guidance, and ReviewMark configuration to align with the new standards and review-set naming.
Reviewed changes
Copilot reviewed 23 out of 69 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| requirements.yaml | Updates ReqStream include paths to the new docs/reqstream/vhdltest/ structure. |
| lint.sh | Refactors lint execution into Python/NPM/.NET sections with skip flags on toolchain failure. |
| lint.bat | Windows equivalent of the lint script refactor (Python/NPM/.NET sections). |
| docs/reqstream/vhdltest/vhdltest.yaml | Adds system-level requirements for core CLI behavior and execution outcomes. |
| docs/reqstream/vhdltest/program.yaml | Adds Program unit requirements. |
| docs/reqstream/vhdltest/platform-requirements.yaml | Adds OS and .NET runtime support requirements. |
| docs/reqstream/vhdltest/cli/cli.yaml | Adds CLI subsystem requirements (with children links). |
| docs/reqstream/vhdltest/cli/context.yaml | Adds Context unit requirements. |
| docs/reqstream/vhdltest/cli/config-document.yaml | Adds ConfigDocument unit requirements. |
| docs/reqstream/vhdltest/cli/options.yaml | Adds Options unit requirements. |
| docs/reqstream/vhdltest/simulators/simulators.yaml | Adds Simulators subsystem requirements (with children links). |
| docs/reqstream/vhdltest/simulators/simulator-factory.yaml | Adds SimulatorFactory unit requirements. |
| docs/reqstream/vhdltest/simulators/ghdl-simulator.yaml | Adds GHDL simulator unit requirements. |
| docs/reqstream/vhdltest/simulators/nvc-simulator.yaml | Adds NVC simulator unit requirements. |
| docs/reqstream/vhdltest/simulators/modelsim-simulator.yaml | Adds ModelSim simulator unit requirements. |
| docs/reqstream/vhdltest/simulators/questasim-simulator.yaml | Adds QuestaSim simulator unit requirements. |
| docs/reqstream/vhdltest/simulators/vivado-simulator.yaml | Adds Vivado simulator unit requirements. |
| docs/reqstream/vhdltest/simulators/active-hdl-simulator.yaml | Adds Active-HDL simulator unit requirements. |
| docs/reqstream/vhdltest/run/run.yaml | Updates Run subsystem requirements to include children links to unit requirements. |
| docs/reqstream/vhdltest/run/run-processor.yaml | Adds RunProcessor unit requirements. |
| docs/reqstream/vhdltest/run/run-program.yaml | Adds RunProgram unit requirements. |
| docs/reqstream/vhdltest/run/run-results.yaml | Adds RunResults unit requirements. |
| docs/reqstream/vhdltest/run/run-types.yaml | Adds Run types unit requirements. |
| docs/reqstream/vhdltest/results/results.yaml | Updates Results subsystem requirements to include children links to unit requirements. |
| docs/reqstream/vhdltest/results/test-result.yaml | Adds TestResult unit requirements. |
| docs/reqstream/vhdltest/results/test-results.yaml | Adds TestResults unit requirements. |
| docs/reqstream/vhdltest/self-test/self-test.yaml | Adds children links from SelfTest subsystem requirements to Validation unit requirements. |
| docs/reqstream/vhdltest/self-test/validation.yaml | Adds Validation unit requirement for configurable report depth. |
| docs/reqstream/simulators/simulators.yaml | Removes the old simulators subsystem requirements file (migrated under vhdltest/). |
| docs/design/vhdltest/vhdltest.md | Adds system-level design overview and execution flow narrative. |
| docs/design/vhdltest/program.md | Adds Program unit design doc. |
| docs/design/vhdltest/cli/cli.md | Adds CLI subsystem design doc. |
| docs/design/vhdltest/cli/context.md | Adds Context unit design doc. |
| docs/design/vhdltest/cli/config-document.md | Adds ConfigDocument unit design doc. |
| docs/design/vhdltest/cli/options.md | Adds Options unit design doc. |
| docs/design/vhdltest/simulators/simulators.md | Adds Simulators subsystem design doc. |
| docs/design/vhdltest/simulators/simulator.md | Adds Simulator base class unit design doc. |
| docs/design/vhdltest/simulators/simulator-factory.md | Adds SimulatorFactory unit design doc. |
| docs/design/vhdltest/simulators/ghdl-simulator.md | Adds GHDL simulator unit design doc. |
| docs/design/vhdltest/simulators/nvc-simulator.md | Adds NVC simulator unit design doc. |
| docs/design/vhdltest/simulators/modelsim-simulator.md | Adds ModelSim simulator unit design doc. |
| docs/design/vhdltest/simulators/questasim-simulator.md | Adds QuestaSim simulator unit design doc. |
| docs/design/vhdltest/simulators/vivado-simulator.md | Adds Vivado simulator unit design doc. |
| docs/design/vhdltest/simulators/active-hdl-simulator.md | Adds Active-HDL simulator unit design doc. |
| docs/design/vhdltest/run/run.md | Adds Run subsystem design doc. |
| docs/design/vhdltest/run/run-processor.md | Adds RunProcessor unit design doc. |
| docs/design/vhdltest/run/run-program.md | Adds RunProgram unit design doc. |
| docs/design/vhdltest/run/run-results.md | Adds RunResults unit design doc. |
| docs/design/vhdltest/run/run-line.md | Adds RunLine unit design doc. |
| docs/design/vhdltest/run/run-line-rule.md | Adds RunLineRule unit design doc. |
| docs/design/vhdltest/run/run-line-type.md | Adds RunLineType unit design doc. |
| docs/design/vhdltest/results/results.md | Adds Results subsystem design doc. |
| docs/design/vhdltest/results/test-result.md | Adds TestResult unit design doc. |
| docs/design/vhdltest/results/test-results.md | Adds TestResults unit design doc. |
| docs/design/vhdltest/self-test/self-test.md | Adds SelfTest subsystem design doc. |
| docs/design/vhdltest/self-test/validation.md | Adds Validation unit design doc. |
| docs/design/title.txt | Adds Pandoc title metadata for the Design document. |
| docs/design/definition.yaml | Adds Pandoc defaults file to build the consolidated Design document. |
| docs/design/introduction.md | Updates intro to reference the new docs/design/vhdltest/ mirroring. |
| AGENTS.md | Updates agent guidance content and standardizes structure/sections. |
| .reviewmark.yaml | Renames/restructures review-set IDs and updates paths to new docs layout; adds base Simulator unit review-set. |
| .github/workflows/build.yaml | Adds Pandoc + WeasyPrint steps to generate and publish “VHDLTest Design” HTML/PDF. |
| .github/standards/technical-documentation.md | Updates documented docs/reqstream/design folder conventions to be system-scoped. |
| .github/standards/reviewmark-usage.md | Updates ReviewMark usage guidance (commands, structure, review-set patterns). |
| .github/standards/reqstream-usage.md | Updates ReqStream folder structure guidance to be system-scoped. |
| .github/standards/design-documentation.md | Updates design-doc structure guidance to be system-scoped and unit-complete. |
| .github/agents/quality.agent.md | Expands the quality report template (adds explicit Result field + completeness checks). |
| .github/agents/implementation.agent.md | Clarifies required context passed between implementation state machine phases. |
| .github/agents/developer.agent.md | Adds explicit lint-fix sequencing guidance before quality gates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
simulator.mdandSimulator.csfrom theVHDLTest-Simulatorssubsystem review-setVHDLTest-Simulators-Simulatorunit review-set for the Simulator base class (design + source)