Contributing

Jump to bottom

Quadstronaut edited this page Jun 7, 2026 · 1 revision

Contributing

Contributions to PotentPowershell are welcome — new scripts, fixes, improved documentation, or additional Learn/ annotations.

Ground Rules

PowerShell only — this is a PowerShell repository. Scripts that shell out to other languages for their core logic are out of scope.
Scripts/ must include a complete comment-based help block (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .NOTES). Run Get-Help .\your-script.ps1 -Full before submitting — it should render cleanly.
Learn/ additions must follow the existing educational style: explain why, not just what. Annotate surprising behavior, pitfalls, and comparisons to other languages.
No secrets, keys, or personal data in any committed file — not even in comments.
MIT license — by submitting, you agree your contribution is licensed under MIT.

Script Checklist

Before opening a pull request for a new script:

Complete comment-based help block in the script header
Author : Quadstronaut (or your handle) in .NOTES
Requires : line in .NOTES lists all prerequisites (admin, modules, external tools)
All parameters use [CmdletBinding()] if the script has any parameters
Admin check at the top if admin is required — either auto-elevate or exit with a clear message
Tested on at least one machine
Handles the "not installed" case gracefully for external dependencies
Script is placed in the correct category directory

Documentation

The wiki is the canonical deep reference; the README is the quickstart. When adding a script:

Update the README quick-reference table (add a row with the script name, what it does, and admin requirement).
Add a section (or a new wiki page) in the wiki for scripts that have non-obvious behavior, parameters, or caveats.

Pull Requests

Open PRs against the master branch. Include in the PR description:

What the script does (one sentence)
What it was tested against (OS version, PowerShell version, relevant tool versions)
Any known limitations