Skip to content

Commit 85695a0

Browse files
Address Copilot review: validation checklist now catches the <Command> template placeholder
The README template uses 'Get-Help -Name <Command> -Examples' and the guidance tells authors to replace <Command>, but the validation Select-String only matched '-Name ''CommandName''' and <CommandName>, so a README shipping <Command> unchanged would pass. Add <Command> to the pattern list.
1 parent 3f39186 commit 85695a0

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

src/docs/PowerShell/Modules/Repository-Defaults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Before opening a README-only PR, check that the README follows the default and d
299299
```powershell
300300
Select-String -Path README.md -SimpleMatch -Pattern 'Greet-Entity', 'PSModuleTemplate', 'YourModuleName'
301301
Select-String -Path README.md -SimpleMatch -Pattern '{{ NAME }}', '{{ DESCRIPTION }}'
302-
Select-String -Path README.md -SimpleMatch -Pattern "-Name 'CommandName'", '<CommandName>'
302+
Select-String -Path README.md -SimpleMatch -Pattern '<Command>', '<CommandName>', "-Name 'CommandName'"
303303
Select-String -Path README.md -Pattern '^## (Commands|Capabilities)$'
304304
Select-String -Path README.md -Pattern '^Install-Module\b'
305305
git diff --check -- README.md

0 commit comments

Comments
 (0)