Skip to content

PSModule PR authors use canonical guidance without template files - #82

Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
psmodule-pr-defaults
Open

Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
psmodule-pr-defaults

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Oct 31, 2026 •

Copy link
Copy Markdown
Member

When opening a pull request, PSModule contributors use canonical MSX PR-format guidance directly rather than an automatically inherited scaffold. This candidate removes the organization's GitHub PR-template file, with no replacement. The authoring protocol remains canonical guidance; other community defaults and Feature/Bug issue forms retain their behavior.

PR authors read the canonical format, inspect the applicable complete change, author required consumer actions or a justified no-action result, and verify the summary boundary, result-scoped evidence and route-applicable release decision before review. No module code, configuration, workflow input, runtime or installation changes are required by this focused removal. Existing descriptions are not rewritten automatically; template-file removal in other repositories remains separate scoped work.

Removed: Repository-distributed pull request scaffold

The actual .github/pull_request_template.md file is deleted outright. README and contribution guidance link MSX PR Format without distributing, copying or automatically inheriting a scaffold. There is no root, .github, docs, or multiple-template alternative in the isolated candidate. This implements the user's explicit "Remove central defaults too; use canonical PR-format guidance only" decision and the final Repository Standard no-PR-template-files policy.

For a new PR that relied on this organization fallback, use canonical guidance to write the actual description: identify affected consumers, explain what changed and why, then state applicability, compatibility, prerequisites, exact actions or justified no-action, order and observable verification. Keep the complete authored body, ordered applicable result groups, exactly one announcement marker after the leading summary, and scoped supporting evidence. The complete description example is an authoring aid, not a file to store or distribute. No intermediate installation or consumer-code edit is needed for this authoring change. Release-specific instructions and history stay in PR/release records; genuine contribution instructions, other community defaults and product integration templates are unaffected.

Technical details

Final canonical correspondence: MSXOrg/docs#209 was live-head verified at bc03a5992615f65d1d5346dc48e7506e80b8b6ca, ready for review but unmerged. The no-file rule is owned by Repository Standard, with Organization Standard and governance-source pointers. PR Format owns the complete description example and authoring procedure; it contains no GitHub PR-template-file policy or deletion discussion. All five final pinned paths and heading anchors were retrieved and verified. The earlier copy-the-complete-template heading is obsolete, and no such link remains in current repository docs or this description.

For release-bound records, actual-publication-baseline-first analysis precedes the title, result inventory, actions and compatibility decision. It identifies the product/target/channel, actual last successful artifact and immutable source, exact candidate, lineage and full source comparison; a PR-base diff is retained separately. This community-default route has no Release Management or native artifact publisher, so it has no publication-baseline claim, Release decisions block or release labels. The canonical defaults, supported-caller/explicit-bump rules and Task/Bug planning remain authoring guidance, not a new runtime resolver.

Exact scoped comparison: main is still f424237c98b5b020f80e8c9563dbc37256fc1ec0; it contains the legacy template at blob 13e45de9d91b403a54a04dfa4fdbff34345a32f3. The isolated removal candidate is PSModule/.github@0f0cef0c1fbb582bf7bf29c26ad96fee0d6d0bc4. No deletion is claimed integrated. The complete base-to-head delta is the one file deletion and direct authoring additions in README/CONTRIBUTING. Earlier scaffold-copy commits and correspondence are historical evidence, not distribution authority after the explicit reversal.

The existing local authoring links already follow the final policy/authoring ownership split; this final correspondence refresh changes only issue/PR evidence, not files or the reviewed head. Community policies, Feature/Bug forms, repository-specific contribution routing, agent files, media, validator code and the operational audit remain preserved.

Changed surface Standards checked Framework docs checked Result
Deleted .github/pull_request_template.md Final Repository Standard no-file policy; explicit user decision Organization Standard and governance-source distribution contract Aligned
README.md authoring pointer README context, Documentation Model, Markdown, Natural Language Canonical PR Format procedure Aligned
.github/CONTRIBUTING.md authoring pointer Contribution Workflow, PR Format, Markdown, Natural Language Existing Process-PSModule entrypoint preserved Aligned

Verification and plan: the revised Task's scoped removal, docs, preservation, full review and correspondence steps are complete; the final source audit records the refreshed pin and policy ownership. Pre-removal inventory failed the no-file condition as expected. Post-removal recursive local inventory and the complete, untruncated pushed Git tree contain zero actual single-file or directory variants, with exactly the three owned changed surfaces. The working tree is clean.

Command or input Result
Recursive Get-ChildItem -LiteralPath $root -Recurse -Force assertions for actual PR-template files/directories Passed; zero variants after expected baseline failure
Complete pushed-tree assertions at 0f0cef0c1fbb582bf7bf29c26ad96fee0d6d0bc4 Passed; zero variants and no replacement
git diff --check, git diff --cached --check, git diff main...HEAD --check Passed for the removal and complete scoped delta
Invoke-WebRequest -Uri $url -MaximumRedirection 5 for all four README/contribution reference URLs Passed; all HTTP 200
gh api --method POST markdown --input - for complete README, CONTRIBUTING and authored PR bodies in GFM mode Passed; links and result-scoped record render
Final canonical files and anchors at bc03a5992615f65d1d5346dc48e7506e80b8b6ca Passed; no-file policy, organization/governance pointers, complete example and coverage-first analysis resolve

Independent validator ownership: Task PSModule/.github#84 and PR PSModule/.github#86 own presence expectations, fixtures, helper/source checks, workflow and validation-specific README text. The exact removed path and head were coordinated with that owner. At inspected validator head 26463d1ea1dac50773156abe9c490a574c1985c6, its separately owned local compatibility evidence reports zero template variants and nine checked Markdown files from this exact removal candidate, with MD025 and missing-CONTRIBUTING failures and 25 regression cases. These are attributed local results, not an experiment performed by this session or the required native check for this PR. This delivery installs no validator in consumers and copies no workflow between branches.

Complete exact-head review: the explicit round on 0f0cef0c1fbb582bf7bf29c26ad96fee0d6d0bc4 converged with no new inline comments, no changes requested and zero unresolved threads. The full review 5724973589 was inspected. Its canonical no-file correspondence concern is now reconciled to the final ready candidate above; actual source/code integration and this PR's required exact-head validation remain open. The successful Copilot review check is not Community file validation and is not human approval.

Governance and readiness: keep this PR draft. The active rule 26275706 is untouched: main-only, exact Community file validation context from GitHub Actions integration 15368, strict freshness, no bypass and preserved inherited reviews. The required named result is still absent on this removal head. Safe ordering is actual normal integration of the separately revised validator, then this PR's own refreshed exact-head PR-event validation; canonical source integration and native prerequisites remain explicit. No fabricated scan, dispatch substitute, check-result mutation or rule bypass is used. Operational Task PSModule/.github#85 and its audit remain unchanged/open for remaining and post-integration evidence; native PBI PSModule/.github#83 remains blocked-by context, not an outcome this diff closes.

Convergence: the scoped sweep covers this no-file delivery and related Template-PSModule request, not unrelated Feature/Bug/YAML work. PSModule/Template-PSModule#40 received the no-central-fallback reconciliation and stays open for owner reconciliation; no template is recreated or issue closed merely because its previous target is absent. This PR closes only its revised Task. No merge, auto-merge, live governance mutation, publication, tag movement, label removal, consumer fleet or unrelated cleanup was performed.

Related references

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The governing scaffold in MSXOrg/docs#209 remains draft and merge-blocked, so source readiness and required CI/governance gates need maintainer confirmation before approval.

No open issues 🎉

What changed in this PR

Expands PSModule’s inherited pull request template into a complete, audience-first release-note scaffold for repositories without a local template. This is a documentation-only change; it does not alter release automation or runtime behavior.

Changes:

  • Adds five ordered result groups with adoption, compatibility, verification, and result-specific evidence prompts.
  • Clarifies announcement boundaries and conditional release decisions, including settings precedence and canonical labels.
  • Adds contribution guidance linking the inherited template and keeping release-specific upgrade instructions in PR descriptions and release notes.
File Description
.github/​pull_request_template.md Provides the complete release-note scaffold and conditional release authoring guidance.
.github/​CONTRIBUTING.md Links the inherited template and clarifies where consumer upgrade instructions belong.

Review effort: Balanced

@MariusStorhaug

Copy link
Copy Markdown
Member Author

Inspected the complete final-head review, including its summary. There are no code findings or inline threads. The summary calls out the draft governing source and required CI/governance confirmation; those remain real prerequisites, with the native validation/enforcement dependency tracked in #83. This PR stays draft. The successful review check is not substituted for an enforced file-validation gate, and no auto-merge or ruleset change is made.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Maintainer confirmation is needed because MSXOrg/docs#209 remains draft and unmerged, while #83 leaves required candidate-head validation and protection enforcement unresolved.

No open issues 🎉

Review effort: Balanced

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title PSModule PR defaults include complete release-note guidance PSModule PR authors use canonical guidance without template files Oct 31, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The required exact-head Community file validation is missing, and pending canonical no-file guidance and separately owned validator integration require reconciliation and independent confirmation.

No open issues 🎉

Review effort: Balanced

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.

Remove PSModule PR-template distribution and use canonical authoring guidance

2 participants