Skip to content

Commit 67112ab

Browse files
docs: Update 'Getting started' section for clarity and detail in module setup instructions
1 parent 8e48f6e commit 67112ab

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

src/docs/PowerShell/Modules/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ Modules are the primary unit of reusable automation in the PowerShell ecosystem.
66

77
## Getting started
88

9-
PSModule provides a standardized framework based on the [Template-PSModule](https://github.com/new?template_name=Template-PSModule&template_owner=PSModule) repository template. All modules follow a consistent directory layout, naming convention, and coding style. The [Process-PSModule](https://github.com/PSModule/Process-PSModule) reusable workflow automates building, testing, and publishing to the PowerShell Gallery. Version increments are driven by PR labels (`Major`, `Minor`, `Patch`, `Prerelease`), and the `RepoType: Module` custom property integrates each repository with organization-wide tooling.
9+
[Create a repo from Template-PSModule](https://github.com/new?template_name=Template-PSModule&template_owner=PSModule), then follow the setup steps in the [Process-PSModule README](https://github.com/PSModule/Process-PSModule#how-to-get-started).
10+
11+
The template ships with placeholder files to illustrate the expected layout — remove them all on the initial commit before writing real code:
12+
13+
- `README.md` — replace `{{ NAME }}` and `{{ DESCRIPTION }}` with real content
14+
- `examples/General.ps1` — replace with a real usage example
15+
- `src/functions/public/PSModule/` — placeholder group folder; delete the entire folder
16+
- `src/functions/public/SomethingElse/` — placeholder group folder; delete the entire folder
17+
- `src/functions/public/Test-PSModuleTest.ps1` — placeholder function; delete
18+
- `src/functions/public/completers.ps1` — placeholder argument completer; delete unless needed
19+
- `tests/PSModuleTest.Tests.ps1` — placeholder tests; delete
20+
21+
Version increments are driven by PR labels (`Major`, `Minor`, `Patch`, `Prerelease`), and the `RepoType: Module` custom property integrates each repository with organization-wide tooling.
1022

1123
- **[Standards](Standards.md)** — Repository layout, naming, style, parameter design, comment-based help, and SOLID applied to PowerShell modules.
1224
- **[Test Specification](Test-Specification.md)** — How we write Pester tests: structure, hierarchy, and naming conventions.

0 commit comments

Comments
 (0)