Skip to content

Commit 8fa3902

Browse files
Set title, scope, and MSX altitude layering for the Repository Standard
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 9fd4e21 commit 8fa3902

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

src/docs/Modules/Repository-Standard.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# PowerShell module repository defaults
1+
# Repository Standard
22

3-
This page defines the default repository contract for PowerShell module repositories in the PSModule organization. It describes what a newly created or maintained module repository should look like before module-specific code, tests, documentation, and managed repository files are considered.
3+
This is the PSModule organization's Repository Standard. It applies to the PSModule organization and is the standard for PowerShell module repositories. It describes what a newly created or maintained module repository should look like before module-specific code, tests, documentation, and managed repository files are considered.
44

5-
The implementation standard still lives in [PowerShell module standard](Standards.md). Type-specific conventions for integration (API) and data modules live in [Module types](Module-Types.md). This page covers repository defaults: files, metadata, README shape, release integration, placeholder handling, shared community files, and managed-file distribution.
5+
This standard operates at the same altitude as the [MSX Enterprise Repository Standard](https://msxorg.github.io/docs/Ways-of-Working/Repository-Standard/): MSX sets the enterprise-wide default, and this standard adds to and adjusts that default for PowerShell module repositories. Rules this standard does not change are inherited from the MSX default; where this standard adds or overrides a rule, it governs PowerShell module repositories.
6+
7+
The implementation standard still lives in [PowerShell module standard](Standards.md). Type-specific conventions for integration (API) and data modules live in [Module types](Module-Types.md). This page covers the repository standard for module repositories: files, metadata, README shape, release integration, placeholder handling, shared community files, and managed-file distribution.
68

79
## Scope
810

9-
These defaults apply to repositories whose primary artifact is a PowerShell module published through the PSModule framework.
11+
This standard applies to repositories whose primary artifact is a PowerShell module published through the PSModule framework.
1012

11-
They do not apply directly to:
13+
It does not apply directly to:
1214

1315
- GitHub Action repositories such as `Build-PSModule`, `Invoke-Pester`, or `Publish-PSModule`.
1416
- Documentation repositories such as `PSModule/docs`.
1517
- Template repositories other than `Template-PSModule`.
1618
- Test, archive, service, or infrastructure repositories that are not published as module artifacts.
1719

18-
Two baseline expectations still apply to every PSModule repository, including the types listed above. Each repository stands on its own: it carries its own governance and community files instead of relying on the organization `.github` fallback, and each repository ships the [agent onboarding files](#agent-onboarding-files) so an agent can work in it without prior context. What differs by type is the concrete file set and layout: the required files, README shape, and framework wiring on the rest of this page are module defaults, and non-module repositories keep only the equivalent baseline appropriate to their own type. This repository, `PSModule/docs`, follows those two baseline expectations itself.
20+
Two baseline expectations still apply to every PSModule repository, including the types listed above. Each repository stands on its own: it carries its own governance and community files instead of relying on the organization `.github` fallback, and each repository ships the [agent onboarding files](#agent-onboarding-files) so an agent can work in it without prior context. What differs by type is the concrete file set and layout: the required files, README shape, and framework wiring on the rest of this page are the module standard, and non-module repositories keep only the equivalent baseline appropriate to their own type. This repository, `PSModule/docs`, follows those two baseline expectations itself.
1921

2022
Each initiative should keep its own repository standards in its central documentation repository. For the PSModule organization, this repository is the source of truth.
2123

0 commit comments

Comments
 (0)