Skip to content

⚙️ [Maintenance]: Move coding standards to copilot-instructions and update parameter set naming guidelines#551

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit intomainfrom
instructions
Feb 17, 2026
Merged

⚙️ [Maintenance]: Move coding standards to copilot-instructions and update parameter set naming guidelines#551
Marius Storhaug (MariusStorhaug) merged 1 commit intomainfrom
instructions

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Feb 17, 2026

The coding standards document is moved from the repository root to the standard .github/copilot-instructions.md location recognized by GitHub Copilot, and the parameter set naming guidelines are updated with clearer, more comprehensive rules.

Copilot instructions location

The CodingStandard.md file 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:

  • Functions with a single parameter set do not need a name or DefaultParameterSetName.
  • Functions with multiple parameter sets must use descriptive names that tell the user what each set does.
  • Generic names like '__AllParameterSets' or 'Default' are explicitly prohibited.
  • Parameter sets should be named after the action or scope they represent (e.g., 'List repositories for authenticated user').
  • Public functions calling private functions should use the private function's synopsis as the parameter set name.

@github-actions
Copy link
Contributor

No Significant Changes Detected

This PR does not contain changes to files that would trigger a new release:

Path Description
src/** Module source code
README.md Documentation

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.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: Update copilot-instructions with parameter set naming guidelines ⚙️ [Maintenance]: Move coding standards to copilot-instructions and update parameter set naming guidelines Feb 17, 2026
@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit f2e9658 into main Feb 17, 2026
46 of 47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant