Skip to content

Add PSModule build validation guidance to Process-PSModule #93

Description

Context and request

Add one readable Process-PSModule page that extends the shared MSXOrg Workflow Build/Implement step with PSModule-specific validation guidance for module changes after scaffolding or implementation and before a draft PR leaves self-review.

This page must work for both human contributors and coding agents, stay scoped to PSModule module repositories, and link to canonical standards instead of duplicating them.

This is related to, but distinct from, #91. That issue is about multi-session orchestration and release-branch coordination. This issue is about the validation checks a contributor runs on a module change before marking a draft PR ready.

Acceptance criteria

  • src/docs/Modules/Process-PSModule/ contains one new process page dedicated to PSModule module build-validation guidance.
  • The page is explicitly framed as extending the shared MSXOrg Workflow Build/Implement step for PSModule repositories and links to the live MSXOrg workflow guidance instead of restating it.
  • The page documents, in one numbered sequence, validation checks for module design alignment, module documentation, function structure, function documentation, PowerShell best practices, and final coding-standards alignment.
  • Each validation step states what to look for and links to the canonical PSModule or MSXOrg source of truth.
  • The page ends with a "Where this connects" section linking back to the shared workflow and the relevant PSModule standards pages.
  • src/docs/Modules/Process-PSModule/index.md links to the new page.
  • src/docs/Modules/index.md is updated only if needed for discoverability.

Constraints and non-goals

  • Do not create separate agent-role pages or a replacement workflow.
  • Do not duplicate the canonical content of the MSXOrg coding standards or workflow pages.
  • Do not modify MSXOrg/docs; only update PSModule/docs.

Technical decisions

  • Treat this as one documentation Task delivered in one draft pull request.
  • Keep the new page alongside the existing Process-PSModule pages so it sits next to repository-structure, module-anatomy, and build-test-pack-publish.
  • Use live MSXOrg links that work today, but word the content so it still reads naturally as the shared workflow terminology continues shifting from agent-role pages toward workflow-stage pages.
  • Prefer links to Modules/Standards.md, Modules/Module-Types.md, Modules/Repository-Defaults.md, Process-PSModule/module-anatomy.md, and the MSXOrg PowerShell/coding standards rather than copying their rules.

Implementation plan

  • Re-read the local Process-PSModule and module-standard pages plus the live MSXOrg workflow, issue/PR format, and PowerShell standards that this page will reference.
  • Draft the new Process-PSModule validation page with YAML front matter, a numbered validation flow, and a closing "Where this connects" section.
  • Update Process-PSModule navigation and adjust the parent Modules index only if it needs an extra discovery link.
  • Open the draft PR from the first micro-commit, then push follow-up micro-commits for the page and navigation updates.
  • Self-review the diff, run the repo-supported review loop, and keep the PR in draft for wording review.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions