Skip to content

Align repo with TemplateDotNetTool template patterns for release#95

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/run-agents-for-release
Feb 20, 2026
Merged

Align repo with TemplateDotNetTool template patterns for release#95
Malcolmnixon merged 4 commits intomainfrom
copilot/run-agents-for-release

Conversation

Copy link
Contributor

Copilot AI commented Feb 20, 2026

Pull Request

Description

Pre-release consistency pass aligning VHDLTest with the upstream TemplateDotNetTool template.

  • .config/dotnet-tools.json: Bump buildmark 0.2.0 → 0.3.0
  • package.json: dependenciesdevDependencies (these are dev tools, not runtime deps)
  • lint.sh / lint.bat: Add explicit -c .yamllint.yaml to yamllint; drop redundant "#node_modules" from markdownlint (already in .markdownlint-cli2.jsonc ignores)
  • .markdownlint-cli2.jsonc: Add "MD025": false to match template
  • docs/guide/guide.md: Restructure user guide heading hierarchy to match template pattern:
    • Remove root # VHDLTest User Guide heading (title is populated from title.txt for PDF)
    • Promote all major sections to root-level # headings (Installation, Supported Simulators, Configuration, Running Tests, Self-Validation, CI/CD Integration, Troubleshooting, Best Practices, Appendix)
    • Replace "Key Features" with a ## Scope subsection under # Introduction (containing both Purpose and Scope)
    • No markdown Table of Contents needed (Pandoc auto-generates it via table-of-contents: true in definition.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 proof
  • AGENTS.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.jsonc reference

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

Related Issues

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 tests pass: dotnet test --configuration Release
  • 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 '**/*.{yml,yaml}'

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

Config/script and documentation-only changes — no production code modified. 99/99 tests pass, zero warnings. buildmark 0.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.

@Malcolmnixon
Copy link
Contributor

@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 AI changed the title [WIP] Run all agents for new tool release Align repo with TemplateDotNetTool template patterns for release Feb 20, 2026
Copilot AI requested a review from Malcolmnixon February 20, 2026 14:49
@Malcolmnixon
Copy link
Contributor

@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>
Copy link
Contributor Author

Copilot AI commented Feb 20, 2026

@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 comp...

Restructured the guide in commit d8c8541. Removed the # VHDLTest User Guide root heading (title is populated from title.txt), promoted all major sections to root-level # headings, and replaced the "Key Features" section with a proper ## Scope subsection under # Introduction (which now contains both Purpose and Scope). The document no longer has a markdown navigation table since Pandoc generates the Table of Contents automatically.

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

Copilot AI commented Feb 20, 2026

@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 h...

Added in commit 00b3084. Ported the test source filter documentation from template commit 7b146ce:

  • Added requirements testing strategy comment block to requirements.yaml explaining the three test categories and all VHDLTest-specific source filter prefixes (ghdl@, nvc@, windows@, ubuntu@, dotnet8.x@, dotnet9.x@, dotnet10.x@)
  • Added "Test Source Filters" section to AGENTS.md with the critical warning not to remove filters
  • Added note that not all tests need to be linked to requirements
  • Fixed stale .markdownlint.json reference to .markdownlint-cli2.jsonc in AGENTS.md

@Malcolmnixon Malcolmnixon marked this pull request as ready for review February 20, 2026 15:30
@Malcolmnixon Malcolmnixon merged commit 16e1c44 into main Feb 20, 2026
19 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/run-agents-for-release branch February 20, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants