Repository navigation
Module reference guidance states concrete development rules - #566
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
Open
7 tasks done
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified in this documentation-only clarification of module-development conventions.
No open issues 🎉
What changed in this PR
This documentation-only PR clarifies module-development conventions in the Process-PSModule reference without changing module or pipeline behavior.
Changes:
- Replaces metaphors with direct descriptions of integration modules, transport choices, and Context settings.
- Clarifies conversions through the PowerShell object model while retaining both conversion directions.
- Preserves the previous conversion-section anchor alongside the renamed heading.
| File | Description |
|---|---|
docs/content/reference/module-types.md |
Clarifies integration and data module guidance while preserving technical requirements and anchor compatibility. |
Review effort: Balanced
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Module authors have direct reference guidance for integration modules, data conversion, Pester test structure, framework test jobs, and guidance-script maintenance. This documentation change preserves the existing technical contracts. Module and pipeline behavior do not change, and no consumer action is required.
Changed: Module development references use direct technical prose
The references replace metaphors and vague assurances with concrete descriptions and direct instructions. They distinguish conventions from proof of enforcement. The no-mocks prohibition, Context requirements, conversion directions, test hierarchy, public names, paths, samples, and framework test IDs retain their meaning.
The conversion section has a descriptive heading and retains its previous
#the-neutral-object-is-the-pivotanchor. No cross-owner link change is required. The dependency reference remains unchanged because its roles and version statement are already clear.Technical details
Delivery and comparison. #556 owns this one focused prose delivery. The immutable comparison is
64ffb1d87f86bd5d487891fdb140b78385a00531to5ee3e9393c6bd47f78def6b5841cf22ecacad86f. The remote branch and PR head match the delivered SHA. The PR stays in draft; no merge, auto-merge, or Agent merge action is taken.Three small commits deliver the change:
8d148a49fa24915dc6bbb5b5acd92bd93e27c2f9states module-type conventions,b158a5312295ec0271c6d967aca24bd81b3d6772states Pester test rules, and5ee3e9393c6bd47f78def6b5841cf22ecacad86fclarifies test jobs and script maintenance. The draft was opened after the first coherent commit. Ownership checks immediately before the commits inspected 11, 14, and 16 open PRs and found no other owner of an assigned path.Complete reviewed scope. All six assigned documents were read in full before editing and after the final edits. The five changed paths below are the complete PR diff.
docs\content\reference\dependencies.md04e3e15b239a7e9390bed9d91e043d70ed2ce5bf.docs\content\reference\framework-test-ids.mddocs\content\reference\guidance-scripts.mdguidance/. Script names, table content, environment caution, and content preservation remain.docs\content\reference\module-development-foundations.mddocs\content\reference\module-types.mddocs\content\reference\test-specification.mdBefore/after acceptance evidence. The pre-edit review records the source criteria, actual baseline text, expected changes, and exclusions before editing.
Get-Uritests under theUrimodule and uses separate contexts for direct and pipeline input."Should -Not -Throwassertion.guidance/Pinned source criteria. The writing baseline is MSXOrg/docs at
1b0d4893c8fefabe604d04393068a8ff6f848082:The official STE description, FAQ, and Issue 9 were available. Rules 1.1-1.3, 3.2, 3.6, 5.1-5.4, 6.1-6.5, and 9.1-9.4 and relevant dictionary material informed the manual review. The supplied PDF's MD5,
9c720341c350ed77943b2c73d01c716f, matches the official Zenodo record. The reference files remain local and read-only. This review does not claim complete STE conformance or certification; lint and word counts do not establish it.framework-test-ids.mdguidance-scripts.mdmodule-development-foundations.mdmodule-types.mdtest-specification.mdValidation. These existing commands pass:
Markdownlint reports six files and zero issues before editing and at the final head (markdownlint-cli2 0.24.0, markdownlint 0.42.0). The site build reports "No issues found" before editing and after the final edit. Whitespace checks pass. Inline Python standard-library comparisons at the committed final head verify the unchanged front matter, link targets, source-code test rows, IDs, skip examples, module-test names, guidance table, REST mapping, command patterns, identifiers, Pester sample, hierarchy, and naming examples. All five original prose acceptance failures are absent.
A final generated-HTML comparison preserves all 132 baseline HTML IDs across the six pages.
HTMLParserresolves all 41 rendered local article links and fragments, including both conversion anchors. The complete tracked-path comparison finds five changed paths, one reviewed/no-change path, 330 excluded paths, and zero excluded changes. The worktree is clean after removal of only task-generated site/cache outputs.Final-head GitHub checks: 22 passed; one skipped; none pending or failing. The Docs
Publishjob is skipped for a PR, as the existing workflow specifies. The explicitly requested final-head review is approved at5ee3e9393c6bd47f78def6b5841cf22ecacad86fwith no inline comments.An initial
--site-dirbuild attempt failed because the installed Zensical CLI does not support that option. The unmodified repository build command passed. No tool or dependency was installed or added. The repository has noTest-DocumentationLink.ps1orTest-CrossRepositoryLink.ps1; external URL availability is not asserted. Runtime Pester tests were not run because no executable source or sample changed.Exclusions. Every tracked path outside the six-row reviewed scope is excluded. The complete excluded reference list is
pipeline-stages.md,powershell-module-standard.md,repository-standard.md,scenario-matrix.md,settings.md,versioning.md, andworkflow-inputs.md, all underdocs\content\reference\. All four specification pages remain excluded:docs\content\specification\design.md,index.md,principles-and-practices.md, andspec.md. All guides, getting-started pages, indexes, glossary/module pages, skills, source code, native help, tests, functional test-fixture Markdown, configuration, site design, README files, and guidance-script source remain unchanged. #551 is outside this delivery.Unresolved policy exception. The baseline test specification says "No Mocks: We do not use mocks in tests." The reserved
powershell-module-standard.md#testssays "Unit tests mock boundaries owned by the module, not third-party APIs or SDKs directly." The delivered instruction is "No Mocks: Do not use mocks in tests." It preserves the prohibition without choosing a policy or claiming enforcement. #563 owns the unresolved contradiction and is not closed by this PR. There is no blocker to this prose-only draft.Plan and issue convergence. Source review, pre-edit evidence, baseline checks, three prose slices, invariant review, final checks, and durable evidence complete the delivery leaf's plan. The scoped search covered the documentation-writing leaves and open issues whose bodies name
module-typesortest-specification. #479 requires module audits, #483 requires a resilience contract, #338 requires DSC support, and #471 requires dependency-versioning guidance. This diff does not deliver those outcomes. No additional issue fully converges. Only #556 is a closing reference.The documentation-only paths do not invoke
.github/workflows/Release.yml; no release labels or release-decision block apply.Related references