Skip to content

📖 [Docs]: Repository Standard replaces Repository Defaults and aligns with MSX#96

Draft
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs-95-repository-standard-alignment
Draft

📖 [Docs]: Repository Standard replaces Repository Defaults and aligns with MSX#96
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs-95-repository-standard-alignment

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

The PSModule module-repository page is now the organization's Repository Standard. It states plainly that it applies to the PSModule organization and is the standard for PowerShell module repositories, and that it operates at the same altitude as the MSX Enterprise Repository Standard: MSX sets the enterprise-wide default, and this standard adds to and adjusts that default for PowerShell module repositories. The required-files list is corrected to match that layering, so repositories are no longer told to carry files that are no longer part of the baseline.

Changed: The page is now the Repository Standard

The page previously titled "PowerShell module repository defaults" is now "Repository Standard". Its scope and intro say it is the PSModule organization's standard for PowerShell module repositories, and a new layering statement links to the MSX Enterprise Repository Standard so readers know which rules are inherited from MSX and which this standard adds or overrides. The file was renamed from Repository-Defaults.md to Repository-Standard.md, and every navigation entry and cross-page link now points to the new page.

Changed: Required baseline files align with the MSX standard

The required-files tables no longer list .github/copilot-instructions.md, .github/release.yml, or the linter configuration files (.github/linters/.markdown-lint.yml, .github/linters/.powershell-psscriptanalyzer.psd1) as required baseline files. Module-specific files stay required, including .github/PSModule.yml, and the agent onboarding files AGENTS.md and CLAUDE.md. The descriptions for .github/pull_request_template.md, .gitattributes, .gitignore, and .github/dependabot.yml are reworded to explain what each file does for a PowerShell module repository.


Technical details
  • Renamed src/docs/Modules/Repository-Defaults.mdsrc/docs/Modules/Repository-Standard.md with git mv (100% similarity, history preserved).
  • Updated references in src/zensical.toml (nav label + path), src/docs/Modules/index.md, src/docs/Modules/Module-Types.md, and src/docs/Modules/Process-PSModule/module-build-validation.md.
  • Rewrote the H1, scope, and added the altitude/layering statement; reconciled the prior "initiative implementation" framing with the MSX-altitude framing.
  • Edited both the "Default repository layout" table and the "Required common files" table per the required-files changes.
  • Delivered as three micro-commits (no conventional-commit prefixes): (a) rename + references, (b) title + scope + layering, (c) required-files table edits.
Changed surface Standards checked Framework docs checked Result
src/docs/Modules/** (docs) MSX Repository Standard, PR Format PSModule module docs Aligned
src/zensical.toml (nav) Documentation Model Zensical nav Aligned
Relevant issues (or links)

… and references

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…lease.yml, and linter baseline; reword file purposes

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📖 [Docs]: Rename Repository-Defaults to Repository Standard and align with MSX

1 participant