Apply semantic requirement IDs and documentation fixes from TemplateDotNetLibrary#50
Merged
Malcolmnixon merged 2 commits intomainfrom Mar 3, 2026
Merged
Conversation
…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
approved these changes
Mar 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 IDsReplaces opaque numeric IDs (
TMPL-CMD-001…TMPL-PLT-005) with self-documenting semantic IDs aligned with the library pattern:TMPL-CMD-001Template-Cmd-ContextTMPL-CMD-002Template-Cmd-VersionTMPL-CMD-003Template-Cmd-HelpTMPL-CMD-004Template-Cmd-SilentTMPL-CMD-005Template-Cmd-ValidateTMPL-CMD-006Template-Cmd-ResultsTMPL-CMD-007Template-Cmd-LogTMPL-CMD-008Template-Cmd-ErrorOutputTMPL-CMD-009Template-Cmd-InvalidArgsTMPL-CMD-010Template-Cmd-ExitCodeTMPL-PLT-001…005Template-Platform-Windows/Linux/Net8/Net9/Net10CONTRIBUTING.md— Two accuracy fixesAssert.HasCountargument order: documented as(collection, expectedCount)but the MSTest v4 signature is(expectedCount, collection)— would produce broken tests if followed literally.UTF-8 with BOM→UTF-8. The.editorconfigsetscharset = utf-8globally; the BOM wording was only correct for C# files and misleading everywhere else.AGENTS.md— Encoding descriptionSame encoding fix:
UTF-8+BOM→UTF-8, preventing agents from incorrectly adding BOMs to YAML/JSON/Markdown files.Type of Change
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.TemplateDotNetTool --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
Requirement IDs in test links within
requirements.yamldo 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.