Skip to content

README.md

Latest commit

 

History

History
29 lines (18 loc) · 1.34 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.34 KB
Raw

Template-PSModule

The canonical starting template for new PowerShell modules in the PSModule organization.

Purpose

Use this template when creating a new PowerShell module repository. It provides the CI/CD framework wiring, required community files, and starter layout that every PSModule module repository needs.

For step-by-step instructions, see the template quickstart.

After creating a repository from this template

  1. Replace the {{ NAME }} and {{ DESCRIPTION }} placeholders throughout the repository.
  2. Replace the starter function, test, and example with your module's first real command.
  3. Set the repository description and custom properties on GitHub.
  4. Confirm .github/PSModule.yml only overrides defaults when your module needs different behavior.
  5. Open a draft pull request and run the full CI pipeline.

See repository defaults for the full checklist.

Prerequisites

Modules built from this template use the PSModule framework for building, testing, and publishing.

Contributing

To contribute to this template itself, read the Contribution guidelines. For agents and AI tools, start with AGENTS.md.