⚙️ [Maintenance]: Split README standard and rollout evidence#65
Merged
Conversation
Trimming a module README must not delete unique information. Adds a content-preservation rule (keep/trim/relocate, never drop), makes the capabilities showcase mandatory for implemented modules, carves out an upstream attribution and licensing exception, fixes the copy/paste-hostile Get-Help example, and extends README validation.
The README publishes as the module landing page; a bare top-level docs/ is not published by the docs build. Correct the relocation guidance to only published homes (README, group overview pages under src/functions/public, comment-based help) and state that a longer README is acceptable rather than deleting narrative content to shorten it.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
changed the title
…> 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.
Marius Storhaug (MariusStorhaug)
force-pushed
the
docs/61-readme-standard
branch
from
July 18, 2026 13:22
12ab325 to
0cca80d
Compare
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
July 18, 2026 13:38
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
1 participant
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.
This PR extracts the README-focused part of #61 into its own reviewable scope.
Included
Why
PR #61 combined multiple topics. This split isolates README policy so review can focus on one concern.
Traceability