Skip to content

Apply semantic requirement IDs and documentation fixes from TemplateDotNetLibrary#50

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/review-sister-template-changes
Mar 3, 2026
Merged

Apply semantic requirement IDs and documentation fixes from TemplateDotNetLibrary#50
Malcolmnixon merged 2 commits intomainfrom
copilot/review-sister-template-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 3, 2026

Mirrors recent improvements from the TemplateDotNetLibrary sister template, specifically the switch to semantic requirement IDs and a pair of documentation accuracy fixes.

Changes

requirements.yaml — Semantic requirement IDs

Replaces opaque numeric IDs (TMPL-CMD-001TMPL-PLT-005) with self-documenting semantic IDs aligned with the library pattern:

Before After
TMPL-CMD-001 Template-Cmd-Context
TMPL-CMD-002 Template-Cmd-Version
TMPL-CMD-003 Template-Cmd-Help
TMPL-CMD-004 Template-Cmd-Silent
TMPL-CMD-005 Template-Cmd-Validate
TMPL-CMD-006 Template-Cmd-Results
TMPL-CMD-007 Template-Cmd-Log
TMPL-CMD-008 Template-Cmd-ErrorOutput
TMPL-CMD-009 Template-Cmd-InvalidArgs
TMPL-CMD-010 Template-Cmd-ExitCode
TMPL-PLT-001005 Template-Platform-Windows/Linux/Net8/Net9/Net10

CONTRIBUTING.md — Two accuracy fixes

  • Assert.HasCount argument order: documented as (collection, expectedCount) but the MSTest v4 signature is (expectedCount, collection) — would produce broken tests if followed literally.
  • Encoding: UTF-8 with BOMUTF-8. The .editorconfig sets charset = utf-8 globally; the BOM wording was only correct for C# files and misleading everywhere else.

AGENTS.md — Encoding description

Same encoding fix: UTF-8+BOMUTF-8, preventing agents from incorrectly adding BOMs to YAML/JSON/Markdown files.

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.TemplateDotNetTool --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

  • 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

Requirement IDs in test links within requirements.yaml do not affect test result matching — the linked test names are unchanged. No test files were modified.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…otNetLibrary

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Review and improve semantic requirements in template Apply semantic requirement IDs and documentation fixes from TemplateDotNetLibrary Mar 3, 2026
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 3, 2026 20:19
@Malcolmnixon Malcolmnixon merged commit f97fca8 into main Mar 3, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/review-sister-template-changes branch March 3, 2026 20:19
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