|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for contributing to `Template-PSModule`. |
| 4 | +This file describes how to work on the template itself — not how to use it. |
| 5 | +If you want to create a new module from this template, see the [template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/). |
| 6 | + |
| 7 | +## What this repository is |
| 8 | + |
| 9 | +`Template-PSModule` is the canonical starting template for new PowerShell modules in the PSModule organization. |
| 10 | +Changes to this repository affect every module created from it going forward. |
| 11 | +Keep changes focused: structural layout, required community files, CI/CD wiring, and framework defaults. |
| 12 | + |
| 13 | +## Before you start |
| 14 | + |
| 15 | +1. Read [`AGENTS.md`](AGENTS.md) for the guidance chain and documentation references. |
| 16 | +2. Familiarise yourself with the [repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) that this template must satisfy. |
| 17 | +3. Check the open issues and pull requests to avoid duplicate work. |
| 18 | + |
| 19 | +## Workflow |
| 20 | + |
| 21 | +This project follows the [MSXOrg contribution workflow](https://msxorg.github.io/docs/Ways-of-Working/Contribution-Workflow/): |
| 22 | + |
| 23 | +1. Open or pick up an issue that describes the change. |
| 24 | +2. Create a branch from `main` following the `<type>/<issue>-<short-slug>` convention (e.g. `feat/42-add-security-md`). |
| 25 | +3. Make small, focused commits and push often. |
| 26 | +4. Open a **draft PR** as soon as the change has a basic shape — early feedback is preferred. |
| 27 | +5. Mark the PR ready for review once CI is green and the change is complete. |
| 28 | + |
| 29 | +For branching details, see [Branching and Merging](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/). |
| 30 | + |
| 31 | +## Pull requests |
| 32 | + |
| 33 | +- Keep PRs small and focused on a single deliverable. |
| 34 | +- The PR title should follow the [commit conventions](https://msxorg.github.io/docs/Ways-of-Working/Commit-Conventions/). |
| 35 | +- Auto-merge is enabled; the PR lands as soon as all required checks pass and a reviewer approves. |
| 36 | + |
| 37 | +For PR format guidance, see [PR Format](https://msxorg.github.io/docs/Ways-of-Working/PR-Format/). |
| 38 | + |
| 39 | +## Issues |
| 40 | + |
| 41 | +Use GitHub Issues to report bugs, request features, or propose template changes. |
| 42 | +Follow the [issue format](https://msxorg.github.io/docs/Ways-of-Working/Issue-Format/) guidance. |
| 43 | + |
| 44 | +## Code standards |
| 45 | + |
| 46 | +PowerShell in this template follows the [PSModule Standards](https://psmodule.github.io/docs/Modules/Standards/) and the |
| 47 | +[MSXOrg Coding Standards](https://msxorg.github.io/docs/Coding-Standards/). |
| 48 | + |
| 49 | +## Questions |
| 50 | + |
| 51 | +Open a GitHub Discussion or file an issue if something is unclear. |
0 commit comments