You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Align module setup guidance with repository standard
Document the baseline, required workflow credentials, supported site configuration, and exact caller contract consistently across setup and reference guides.
Co-authored-by: Copilot <223556698+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/content/get-started/index.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,26 +11,28 @@ Start new modules from the PSModule template repository:
11
11
## Quickstart
12
12
13
13
1.[Create a new repository from the template](https://github.com/new?template_name=Template-PSModule&template_owner=PSModule&description=Add%20a%20description%20(required)&name=%3CModule%20name%3E).
14
-
2.[Configure the repository](repository-setup.md) — GitHub Pages, `PSGALLERY_API_KEY`, and the caller workflow.
15
-
3. Replace placeholder metadata and remove scaffold sample files.
14
+
2. Complete the [module repository baseline](repository-setup.md#1-complete-the-module-repository-baseline): replace
15
+
template tokens, remove scaffolding, set `Type: Module`, and confirm required files.
16
+
3.[Configure the repository](repository-setup.md) — GitHub Pages, workflow secrets, the caller workflow, settings, and
17
+
Zensical.
16
18
4. Add your first public command and tests.
17
-
5. Validate `.github/PSModule.yml` defaults for your module.
18
-
6.[Open a draft pull request](your-first-release.md), then release from its resulting important default-branch push.
19
+
5.[Open a draft pull request](your-first-release.md), then release from its resulting important default-branch push.
19
20
20
21
If the module needs several interdependent commands before it is usable at all, see
21
22
[Module bootstrap](module-bootstrap.md) instead of shipping them as one command per step.
22
23
23
24
## Expected outcomes
24
25
25
-
- The repository follows the [expected structure](../guides/structuring-your-module.md).
26
+
- The repository follows the [repository standard](../reference/repository-standard.md) and
├── tests/ # Pester suites; the Simple layout is shown
48
56
│ ├── AfterAll.ps1 (optional) # Cleanup script for ModuleLocal runs
49
57
│ ├── BeforeAll.ps1 (optional) # Setup script for ModuleLocal runs
50
58
│ └── <ModuleName>.Tests.ps1 # Simple: one root-level module suite
51
59
├── .gitattributes # Normalizes line endings across platforms
52
60
├── .gitignore # Excludes build artifacts from source control
53
-
├── LICENSE # License text surfaced in manifest metadata
54
-
└── README.md # Repository overview rendered on GitHub and docs landing
61
+
└── SUPPORT.md # Support expectations
55
62
```
56
63
57
64
The tree shows the [Simple PowerShell test profile](https://msx.no/docs/Coding-Standards/PowerShell/Testing/#simple), not an exclusive test-file shape. Standard keeps one root-level `tests/<Group>.Tests.ps1` file per public function group. Advanced uses recursively discovered subdirectories, and layouts may mix across directories. Process-PSModule defines the exact [per-directory precedence and sibling suppression](writing-module-tests.md#test-discovery).
0 commit comments