⚙️ [Maintenance]: Move coding standards to copilot-instructions and update parameter set naming guidelines#551
Merged
Marius Storhaug (MariusStorhaug) merged 1 commit intomainfrom Feb 17, 2026
Conversation
Contributor
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
February 17, 2026 12:22
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s Copilot coding standards document to provide clearer, more consistent guidance for naming PowerShell parameter sets used across the GitHub module.
Changes:
- Replaces the “Default Parameter Sets” guidance with a more detailed “Parameter Set Naming” section.
- Adds explicit rules for when to omit
DefaultParameterSetName, how to choose it for multi-set functions, and which generic names are prohibited.
Comments suppressed due to low confidence (2)
.github/copilot-instructions.md:41
- The guidance to avoid generic parameter set names like '__AllParameterSets' or 'Default' conflicts with existing public functions in this repo that currently use these names (e.g., Install-GitHubApp.ps1, Get-GitHubEmoji.ps1, Set-GitHubEnvironment.ps1). Consider either updating those functions as part of this change, or adding a short note that this rule applies to new/updated commands and legacy uses will be migrated separately, to avoid confusing contributors.
.github/copilot-instructions.md:44 - Basing public parameter set names directly on the called private function’s synopsis can be brittle (synopsis text/punctuation may change during doc edits, which would rename parameter sets and break switch statements and any scripts relying on those names). Consider clarifying that parameter set names should be stable identifiers, and if derived from synopsis, the synopsis should be treated as a stable string and normalized (e.g., no trailing period).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f2e9658
into
main
46 of 47 checks passed
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.
The coding standards document is moved from the repository root to the standard
.github/copilot-instructions.mdlocation recognized by GitHub Copilot, and the parameter set naming guidelines are updated with clearer, more comprehensive rules.Copilot instructions location
The
CodingStandard.mdfile is renamed to.github/copilot-instructions.md, aligning with the standard location for AI-assisted coding instructions. This is an internal maintenance change — no code or shipped artifact is affected.Parameter set naming guidelines
The previous "Default Parameter Sets" section is replaced with a comprehensive "Parameter Set Naming" section providing clearer rules:
DefaultParameterSetName.'__AllParameterSets'or'Default'are explicitly prohibited.'List repositories for authenticated user').