Skip to content

Align repo with TemplateDotNetTool template patterns for release #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Malcolmnixon merged 4 commits into from
Feb 20, 2026
Merged

Align repo with TemplateDotNetTool template patterns for release #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
501e91e
Initial plan
Copilot Feb 20, 2026
976c9a4
Align repo with TemplateDotNetTool template patterns
Copilot Feb 20, 2026
d8c8541
Restructure user guide headings to match template pattern
Copilot Feb 20, 2026
00b3084
Add test source filter documentation to AGENTS.md and requirements.yaml
Copilot Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
]
},
"demaconsulting.buildmark": {
"version": "0.2.0",
"version": "0.3.0",
"commands": [
"buildmark"
]
Expand Down
1 change: 1 addition & 0 deletions .markdownlint-cli2.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"MD007": { "indent": 2 },
"MD013": { "line_length": 120 },
"MD024": { "siblings_only": true },
"MD025": false,
"MD033": false,
"MD041": false
},
Expand Down
19 changes: 18 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,31 @@ generating test reports.

- **`requirements.yaml`** - All requirements with test linkage (enforced via `dotnet vhdltest --validate`)
- **`.editorconfig`** - Code style (file-scoped namespaces, 4-space indent, UTF-8+BOM, LF endings)
- **`.cspell.json`, `.markdownlint.json`, `.yamllint.yaml`** - Linting configs
- **`.cspell.json`, `.markdownlint-cli2.jsonc`, `.yamllint.yaml`** - Linting configs

## Requirements (VHDLTest-Specific)

- Link ALL requirements to tests (prefer `IntegrationTest_*` tests over unit tests)
- Not all tests need to be linked to requirements (tests may exist for corner cases, design testing, failure-testing, etc.)
- Enforced: `dotnet vhdltest --validate` generates requirements traceability matrix
- When adding features: add requirement + link to test

## Test Source Filters

Test links in `requirements.yaml` can include a source filter prefix to restrict which test results count as
evidence. This is critical for platform, simulator, and framework requirements - **do not remove these filters**.

- `ghdl@TestName` - proves the test passed using the GHDL simulator
- `nvc@TestName` - proves the test passed using the NVC simulator
- `windows@TestName` - proves the test passed on a Windows platform
- `ubuntu@TestName` - proves the test passed on a Linux (Ubuntu) platform
- `dotnet8.x@TestName` - proves the self-validation test ran on a machine with .NET 8.x runtime
- `dotnet9.x@TestName` - proves the self-validation test ran on a machine with .NET 9.x runtime
- `dotnet10.x@TestName` - proves the self-validation test ran on a machine with .NET 10.x runtime

Without the source filter, a test result from any platform/simulator/framework satisfies the requirement. Adding
the filter ensures the CI evidence comes specifically from the required environment.

## Testing (VHDLTest-Specific)

- **Test Naming**: `ClassName_MethodUnderTest_Scenario_ExpectedBehavior` (unit tests) or
Expand Down
Loading
Loading