From 8857d18f245f518436515e64fa6e31ec12f667d1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 12:58:39 +0100 Subject: [PATCH 1/4] Provide the complete inherited PR description scaffold --- .github/pull_request_template.md | 235 ++++++++++++++++++++++++++++++- 1 file changed, 229 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 13e45de..9159a83 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,241 @@ - + - +{{ One or two short summary paragraphs that state what changes, why, who is +affected, and required adoption actions or an explicit no-action result. }} + + + +## Breaking: {{ Reader-facing result }} + +{{ Explain what changes, why, affected supported uses, compatibility, and exact +adoption actions or an explicit no-action result. Include applicable +prerequisites, verification, ordering, and any required intermediate installation +or run. }} + +{{ Interface or old-to-new example, comparison, or diagram after the prose when +needed to make adoption unambiguous. Keep required transition details in this +note; link to evergreen usage docs only for optional depth. Delete when prose +is sufficient. }} + +
+Technical details + +{{ Implementation and validation evidence for this result. }} + +| Changed surface | Standards checked | Framework docs checked | Result | +| --- | --- | --- | --- | +| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | + +{{ For an applicable release-managed result, identify the consumer-change release +and source baseline and evidence supporting the actions or no-action result +above. For an affected integration template, identify its repository, verified +compatible immutable commit, and compatibility evidence. Publication resolves +actual release coordinates; do not predict a final version. Delete inapplicable +evidence. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## Removed: {{ Reader-facing result }} + +{{ Explain what changes, why, affected supported uses, compatibility, and exact +adoption actions or an explicit no-action result. Include applicable +prerequisites, verification, ordering, and any required intermediate installation +or run. }} + +{{ Interface or old-to-new example, comparison, or diagram after the prose when +needed to make adoption unambiguous. Keep required transition details in this +note; link to evergreen usage docs only for optional depth. Delete when prose +is sufficient. }} ----
Technical details - +{{ Implementation and validation evidence for this result. }} + +| Changed surface | Standards checked | Framework docs checked | Result | +| --- | --- | --- | --- | +| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | + +{{ For an applicable release-managed result, identify the consumer-change release +and source baseline and evidence supporting the actions or no-action result +above. For an affected integration template, identify its repository, verified +compatible immutable commit, and compatibility evidence. Publication resolves +actual release coordinates; do not predict a final version. Delete inapplicable +evidence. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## New: {{ Reader-facing result }} + +{{ Explain what changes, why, affected supported uses, compatibility, and exact +adoption actions or an explicit no-action result. Include applicable +prerequisites, verification, ordering, and any required intermediate installation +or run. }} + +{{ Interface or old-to-new example, comparison, or diagram after the prose when +needed to make adoption unambiguous. Keep required transition details in this +note; link to evergreen usage docs only for optional depth. Delete when prose +is sufficient. }} + +
+Technical details + +{{ Implementation and validation evidence for this result. }} + +| Changed surface | Standards checked | Framework docs checked | Result | +| --- | --- | --- | --- | +| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | + +{{ For an applicable release-managed result, identify the consumer-change release +and source baseline and evidence supporting the actions or no-action result +above. For an affected integration template, identify its repository, verified +compatible immutable commit, and compatibility evidence. Publication resolves +actual release coordinates; do not predict a final version. Delete inapplicable +evidence. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## Changed: {{ Reader-facing result }} + +{{ Explain what changes, why, affected supported uses, compatibility, and exact +adoption actions or an explicit no-action result. Include applicable +prerequisites, verification, ordering, and any required intermediate installation +or run. }} + +{{ Interface or old-to-new example, comparison, or diagram after the prose when +needed to make adoption unambiguous. Keep required transition details in this +note; link to evergreen usage docs only for optional depth. Delete when prose +is sufficient. }} + +
+Technical details + +{{ Implementation and validation evidence for this result. }} + +| Changed surface | Standards checked | Framework docs checked | Result | +| --- | --- | --- | --- | +| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | + +{{ For an applicable release-managed result, identify the consumer-change release +and source baseline and evidence supporting the actions or no-action result +above. For an affected integration template, identify its repository, verified +compatible immutable commit, and compatibility evidence. Publication resolves +actual release coordinates; do not predict a final version. Delete inapplicable +evidence. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## Fixed: {{ Reader-facing result }} + +{{ Explain what changes, why, affected supported uses, compatibility, and exact +adoption actions or an explicit no-action result. Include applicable +prerequisites, verification, ordering, and any required intermediate installation +or run. }} + +{{ Interface or old-to-new example, comparison, or diagram after the prose when +needed to make adoption unambiguous. Keep required transition details in this +note; link to evergreen usage docs only for optional depth. Delete when prose +is sufficient. }} + +
+Technical details + +{{ Implementation and validation evidence for this result. }} + +| Changed surface | Standards checked | Framework docs checked | Result | +| --- | --- | --- | --- | +| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | + +{{ For an applicable release-managed result, identify the consumer-change release +and source baseline and evidence supporting the actions or no-action result +above. For an affected integration template, identify its repository, verified +compatible immutable commit, and compatibility evidence. Publication resolves +actual release coordinates; do not predict a final version. Delete inapplicable +evidence. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789
-Relevant issues (or links) +Release decisions - +- **Release:** {{ Yes or No }} - {{ Evidence from the artifact, route, and + supported consumer contract. }} +- **Version bump:** {{ Patch, Minor, or Major }} - {{ Compatibility evidence. + Identify the explicit label, supported caller input, repository setting, or + documented shared default that supplies it. Delete this field when Release + is No. }} +- **Mode:** {{ Stable or Prerelease }} - {{ Target-route or override evidence. + Identify configured release-candidate routing when applicable. Delete this + field when Release is No. }} +- **Labels:** {{ Exact `release:*` labels, or `None` when effective configuration + supplies the decision without an override label. }}
From e7f3df053e276e1fe1fbc9ee6060ca25bae54f5f Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 13:00:27 +0100 Subject: [PATCH 2/4] Explain inherited PR guidance and release-note ownership --- .github/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index de22957..fd201bc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,5 +4,16 @@ Follow the central [MSX contribution workflow](https://msx.no/docs/Ways-of-Worki and [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for shared contribution guidance. +PSModule repositories without a local pull request template inherit the +[PSModule organization template](https://github.com/PSModule/.github/blob/main/.github/pull_request_template.md). +Use its complete scaffold and [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) +for audience-first descriptions and applicable release decisions. + +Each PR describes complete applicable consumer upgrade actions or a justified +no-action result. Release-specific instructions and history stay in PR +descriptions and release notes; evergreen repository documentation describes +supported behavior and usage. Announcement excerpts do not replace the complete +release-note body. + For framework-specific guidance, review the [Process-PSModule documentation](https://psmodule.io/Process-PSModule/). From 90aee54bd9df1f3a716a5fb8a0707ccba4b56f22 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 13:48:15 +0100 Subject: [PATCH 3/4] Make result-scoped delivery evidence explicit in the PR scaffold --- .github/pull_request_template.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9159a83..191e1ff 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -43,7 +43,9 @@ is sufficient. }}
Technical details -{{ Implementation and validation evidence for this result. }} +{{ Implementation and validation evidence, closing delivery-leaf plan progress, +and issue-convergence search scope and outcome for this result, even when no +additional issue converges. }} | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | @@ -82,7 +84,9 @@ is sufficient. }}
Technical details -{{ Implementation and validation evidence for this result. }} +{{ Implementation and validation evidence, closing delivery-leaf plan progress, +and issue-convergence search scope and outcome for this result, even when no +additional issue converges. }} | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | @@ -121,7 +125,9 @@ is sufficient. }}
Technical details -{{ Implementation and validation evidence for this result. }} +{{ Implementation and validation evidence, closing delivery-leaf plan progress, +and issue-convergence search scope and outcome for this result, even when no +additional issue converges. }} | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | @@ -160,7 +166,9 @@ is sufficient. }}
Technical details -{{ Implementation and validation evidence for this result. }} +{{ Implementation and validation evidence, closing delivery-leaf plan progress, +and issue-convergence search scope and outcome for this result, even when no +additional issue converges. }} | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | @@ -199,7 +207,9 @@ is sufficient. }}
Technical details -{{ Implementation and validation evidence for this result. }} +{{ Implementation and validation evidence, closing delivery-leaf plan progress, +and issue-convergence search scope and outcome for this result, even when no +additional issue converges. }} | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | From 0f0cef0c1fbb582bf7bf29c26ad96fee0d6d0bc4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 22:16:11 +0100 Subject: [PATCH 4/4] Remove the distributed PR template and link canonical authoring guidance --- .github/CONTRIBUTING.md | 8 +- .github/pull_request_template.md | 251 ------------------------------- README.md | 3 + 3 files changed, 7 insertions(+), 255 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fd201bc..b2b8078 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,10 +4,10 @@ Follow the central [MSX contribution workflow](https://msx.no/docs/Ways-of-Worki and [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for shared contribution guidance. -PSModule repositories without a local pull request template inherit the -[PSModule organization template](https://github.com/PSModule/.github/blob/main/.github/pull_request_template.md). -Use its complete scaffold and [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) -for audience-first descriptions and applicable release decisions. +Write pull request descriptions using [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) +for audience-first results and applicable release decisions. This repository +does not distribute a GitHub pull request template or an automatically inherited +PR scaffold. Each PR describes complete applicable consumer upgrade actions or a justified no-action result. Release-specific instructions and history stay in PR diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 191e1ff..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,251 +0,0 @@ - - -{{ One or two short summary paragraphs that state what changes, why, who is -affected, and required adoption actions or an explicit no-action result. }} - - - -## Breaking: {{ Reader-facing result }} - -{{ Explain what changes, why, affected supported uses, compatibility, and exact -adoption actions or an explicit no-action result. Include applicable -prerequisites, verification, ordering, and any required intermediate installation -or run. }} - -{{ Interface or old-to-new example, comparison, or diagram after the prose when -needed to make adoption unambiguous. Keep required transition details in this -note; link to evergreen usage docs only for optional depth. Delete when prose -is sufficient. }} - -
-Technical details - -{{ Implementation and validation evidence, closing delivery-leaf plan progress, -and issue-convergence search scope and outcome for this result, even when no -additional issue converges. }} - -| Changed surface | Standards checked | Framework docs checked | Result | -| --- | --- | --- | --- | -| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | - -{{ For an applicable release-managed result, identify the consumer-change release -and source baseline and evidence supporting the actions or no-action result -above. For an affected integration template, identify its repository, verified -compatible immutable commit, and compatibility evidence. Publication resolves -actual release coordinates; do not predict a final version. Delete inapplicable -evidence. }} - -
- -
-Related references - -- Resolves MSXOrg/repository#123 -- References MSXOrg/repository#456 -- Depends on MSXOrg/other-repository#789 - -
- -## Removed: {{ Reader-facing result }} - -{{ Explain what changes, why, affected supported uses, compatibility, and exact -adoption actions or an explicit no-action result. Include applicable -prerequisites, verification, ordering, and any required intermediate installation -or run. }} - -{{ Interface or old-to-new example, comparison, or diagram after the prose when -needed to make adoption unambiguous. Keep required transition details in this -note; link to evergreen usage docs only for optional depth. Delete when prose -is sufficient. }} - -
-Technical details - -{{ Implementation and validation evidence, closing delivery-leaf plan progress, -and issue-convergence search scope and outcome for this result, even when no -additional issue converges. }} - -| Changed surface | Standards checked | Framework docs checked | Result | -| --- | --- | --- | --- | -| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | - -{{ For an applicable release-managed result, identify the consumer-change release -and source baseline and evidence supporting the actions or no-action result -above. For an affected integration template, identify its repository, verified -compatible immutable commit, and compatibility evidence. Publication resolves -actual release coordinates; do not predict a final version. Delete inapplicable -evidence. }} - -
- -
-Related references - -- Resolves MSXOrg/repository#123 -- References MSXOrg/repository#456 -- Depends on MSXOrg/other-repository#789 - -
- -## New: {{ Reader-facing result }} - -{{ Explain what changes, why, affected supported uses, compatibility, and exact -adoption actions or an explicit no-action result. Include applicable -prerequisites, verification, ordering, and any required intermediate installation -or run. }} - -{{ Interface or old-to-new example, comparison, or diagram after the prose when -needed to make adoption unambiguous. Keep required transition details in this -note; link to evergreen usage docs only for optional depth. Delete when prose -is sufficient. }} - -
-Technical details - -{{ Implementation and validation evidence, closing delivery-leaf plan progress, -and issue-convergence search scope and outcome for this result, even when no -additional issue converges. }} - -| Changed surface | Standards checked | Framework docs checked | Result | -| --- | --- | --- | --- | -| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | - -{{ For an applicable release-managed result, identify the consumer-change release -and source baseline and evidence supporting the actions or no-action result -above. For an affected integration template, identify its repository, verified -compatible immutable commit, and compatibility evidence. Publication resolves -actual release coordinates; do not predict a final version. Delete inapplicable -evidence. }} - -
- -
-Related references - -- Resolves MSXOrg/repository#123 -- References MSXOrg/repository#456 -- Depends on MSXOrg/other-repository#789 - -
- -## Changed: {{ Reader-facing result }} - -{{ Explain what changes, why, affected supported uses, compatibility, and exact -adoption actions or an explicit no-action result. Include applicable -prerequisites, verification, ordering, and any required intermediate installation -or run. }} - -{{ Interface or old-to-new example, comparison, or diagram after the prose when -needed to make adoption unambiguous. Keep required transition details in this -note; link to evergreen usage docs only for optional depth. Delete when prose -is sufficient. }} - -
-Technical details - -{{ Implementation and validation evidence, closing delivery-leaf plan progress, -and issue-convergence search scope and outcome for this result, even when no -additional issue converges. }} - -| Changed surface | Standards checked | Framework docs checked | Result | -| --- | --- | --- | --- | -| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | - -{{ For an applicable release-managed result, identify the consumer-change release -and source baseline and evidence supporting the actions or no-action result -above. For an affected integration template, identify its repository, verified -compatible immutable commit, and compatibility evidence. Publication resolves -actual release coordinates; do not predict a final version. Delete inapplicable -evidence. }} - -
- -
-Related references - -- Resolves MSXOrg/repository#123 -- References MSXOrg/repository#456 -- Depends on MSXOrg/other-repository#789 - -
- -## Fixed: {{ Reader-facing result }} - -{{ Explain what changes, why, affected supported uses, compatibility, and exact -adoption actions or an explicit no-action result. Include applicable -prerequisites, verification, ordering, and any required intermediate installation -or run. }} - -{{ Interface or old-to-new example, comparison, or diagram after the prose when -needed to make adoption unambiguous. Keep required transition details in this -note; link to evergreen usage docs only for optional depth. Delete when prose -is sufficient. }} - -
-Technical details - -{{ Implementation and validation evidence, closing delivery-leaf plan progress, -and issue-convergence search scope and outcome for this result, even when no -additional issue converges. }} - -| Changed surface | Standards checked | Framework docs checked | Result | -| --- | --- | --- | --- | -| `{{ Path or interface }}` | {{ Applicable standards }} | {{ Applicable framework docs, or `None (no framework-specific docs)` }} | {{ `Aligned`, `Fixed in this PR`, or `Exception - MSXOrg/repository#123` }} | - -{{ For an applicable release-managed result, identify the consumer-change release -and source baseline and evidence supporting the actions or no-action result -above. For an affected integration template, identify its repository, verified -compatible immutable commit, and compatibility evidence. Publication resolves -actual release coordinates; do not predict a final version. Delete inapplicable -evidence. }} - -
- -
-Related references - -- Resolves MSXOrg/repository#123 -- References MSXOrg/repository#456 -- Depends on MSXOrg/other-repository#789 - -
- -
-Release decisions - -- **Release:** {{ Yes or No }} - {{ Evidence from the artifact, route, and - supported consumer contract. }} -- **Version bump:** {{ Patch, Minor, or Major }} - {{ Compatibility evidence. - Identify the explicit label, supported caller input, repository setting, or - documented shared default that supplies it. Delete this field when Release - is No. }} -- **Mode:** {{ Stable or Prerelease }} - {{ Target-route or override evidence. - Identify configured release-candidate routing when applicable. Delete this - field when Release is No. }} -- **Labels:** {{ Exact `release:*` labels, or `None` when effective configuration - supplies the decision without an override label. }} - -
diff --git a/README.md b/README.md index 0e884f9..803d1ef 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,6 @@ `PSModule/.github` is GitHub's special public organization-defaults repository. GitHub uses its community files when a PSModule repository does not define its own corresponding file. + +Pull request authors follow [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) +directly. This repository does not distribute a GitHub pull request template.