Align repo with TemplateDotNetTool template patterns for release#95
Align repo with TemplateDotNetTool template patterns for release#95Malcolmnixon merged 4 commits intomainfrom
Conversation
|
@copilot An additional release-cleanup task is to update the heading-structure of the user guide. The guide has all its headings under one Title-like root heading. This isn't needed for documents compiled to PDF as the title is populated from title.txt. Additionally Pandoc automatically creates a Table of Contents so the guide doesn't need its own navigation table in Markdown, and should start with an Introduction section containing a Purpose and Scope, and then the critical sections of the document should also be root-level markdown sections. |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot It seems like the special instructions for requirements test source filters have not been properly transferred using the repo-consistency agent. Please re-run the repo-consistency agent and have it review the last weeks changes to the template making sure they are correctly transferred to this repository . |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Restructured the guide in commit d8c8541. Removed the |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Added in commit 00b3084. Ported the test source filter documentation from template commit 7b146ce:
|
Pull Request
Description
Pre-release consistency pass aligning VHDLTest with the upstream TemplateDotNetTool template.
.config/dotnet-tools.json: Bumpbuildmark0.2.0 → 0.3.0package.json:dependencies→devDependencies(these are dev tools, not runtime deps)lint.sh/lint.bat: Add explicit-c .yamllint.yamlto yamllint; drop redundant"#node_modules"from markdownlint (already in.markdownlint-cli2.jsoncignores).markdownlint-cli2.jsonc: Add"MD025": falseto match templatedocs/guide/guide.md: Restructure user guide heading hierarchy to match template pattern:# VHDLTest User Guideheading (title is populated fromtitle.txtfor PDF)#headings (Installation, Supported Simulators, Configuration, Running Tests, Self-Validation, CI/CD Integration, Troubleshooting, Best Practices, Appendix)## Scopesubsection under# Introduction(containing both Purpose and Scope)table-of-contents: trueindefinition.yaml)requirements.yaml: Add requirements testing strategy comment block documenting the three test categories (Unit Tests, Self-Validation Tests, Platform Tests) and all VHDLTest-specific source filter prefixes (ghdl@,nvc@,windows@,ubuntu@,dotnet8.x@,dotnet9.x@,dotnet10.x@) with critical warning that removing filters invalidates evidence-based proofAGENTS.md: Add "Test Source Filters" section documenting source filter syntax; add note that not all tests need to be linked to requirements; fix stale.markdownlint.json→.markdownlint-cli2.jsoncreferenceType 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 ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint '**/*.{yml,yaml}'Testing
Documentation
Additional Notes
Config/script and documentation-only changes — no production code modified. 99/99 tests pass, zero warnings.
buildmark0.3.0 checked against GitHub Advisory DB with no known vulnerabilities. User guide heading structure now matches the TemplateDotNetTool guide pattern with root-level sections and an Introduction containing Purpose and Scope. Test source filter documentation ported from template commit 7b146ce to ensure agents understand the filter syntax and never accidentally remove source filter prefixes from requirements.yaml.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.