From d344a4c425dec52edeb8c4a0c97d0241dd986cb3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 13 Sep 2026 10:53:22 +0200 Subject: [PATCH 01/13] docs: align organization pull request template Guide inherited pull request bodies through the synchronized audience-facing format while keeping classified sections, supporting details, and release metadata optional.\n\nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .github/pull_request_template.md | 45 +++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 13e45de..bb8cf2d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,51 @@ - + +Follow the canonical [MSX PR Format](https://github.com/MSXOrg/docs/blob/main/src/docs/Ways-of-Working/PR-Format.md). +--> + + + + +
-Relevant issues (or links) +Related references - +- owner/repository#123 +- Fixes owner/repository#456
+ +Use fully qualified GitHub references. Use a closing keyword only when this +change fully resolves the issue. +--> + + From 53254b362700f0867f1dc9dd136a6a2580b79da6 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 13 Sep 2026 11:04:42 +0200 Subject: [PATCH 02/13] docs: use neutral announcement marker Use a channel-neutral cutoff name for announcement tooling. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bb8cf2d..b122773 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ with the outcome and do not add a Summary heading. Follow the canonical [MSX PR Format](https://github.com/MSXOrg/docs/blob/main/src/docs/Ways-of-Working/PR-Format.md). --> - + - + - + @@ -41,11 +44,15 @@ blocks scoped to that section and in this order: Use fully qualified GitHub references. Use a closing keyword only when this change fully resolves the issue. + +For internal-only work with no classified section, place any supporting blocks +directly after the announcement marker in the same order. --> From a7e9e9e70d0adb35ff89e9bb8958565664763918 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 13 Sep 2026 11:25:44 +0200 Subject: [PATCH 06/13] docs: add complete pull request scaffold Embed the canonical copy-ready body, including scoped evidence and conditional release decisions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .github/pull_request_template.md | 208 ++++++++++++++++++++++++++----- 1 file changed, 177 insertions(+), 31 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8e6d16c..0ee2949 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,58 +1,204 @@ - + +{{ One or two short summary paragraphs that state what changes, who is affected, +and any required action. }} + - +{{ One or two prose paragraphs that explain the outcome, affected readers, and +required action. }} - +{{ Optional interface example or compact table after the prose. Delete when it +does not help the reader act. }} + +
+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 consumer or template change, record the +release and source baseline, exact consumer action and verification, and the +compatible template repository and immutable commit. Delete when it does not +apply. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## Changed: {{ Reader-facing result }} + +{{ One or two prose paragraphs that explain the outcome, affected readers, and +required action. }} + +{{ Optional interface example or compact table after the prose. Delete when it +does not help the reader act. }} + +
+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 consumer or template change, record the +release and source baseline, exact consumer action and verification, and the +compatible template repository and immutable commit. Delete when it does not +apply. }} + +
+ +
+Related references + +- Resolves MSXOrg/repository#123 +- References MSXOrg/repository#456 +- Depends on MSXOrg/other-repository#789 + +
+ +## Fixed: {{ Reader-facing result }} + +{{ One or two prose paragraphs that explain the outcome, affected readers, and +required action. }} + +{{ Optional interface example or compact table after the prose. Delete when it +does not help the reader act. }} + +
+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 consumer or template change, record the +release and source baseline, exact consumer action and verification, and the +compatible template repository and immutable commit. Delete when it does not +apply. }} + +
+ +
+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. + Delete this field when Release is No. }} +- **Mode:** {{ Stable or Prerelease }} - {{ Target-route or override evidence. + Delete this field when Release is No. }} +- **Labels:** {{ Exact `release:*` labels, or `None` when effective configuration + supplies the decision without an override label. }} + +
From d066ecb2908362d7e6e7e6023f215279d76f5997 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 13 Sep 2026 11:27:43 +0200 Subject: [PATCH 07/13] docs: clarify pull request references Retain the synchronized closing-keyword rule in the inherited template guidance. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0ee2949..0100078 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,6 +7,8 @@ prefixes; issue references; unrelated lists; and AI or agent attribution. Replace every placeholder. Delete unused classifier groups, supporting blocks, examples, and release fields. Keep retained classifier groups in the order shown. Repeat a complete group when one classifier has several distinct results. +Use fully qualified references and closing keywords only for issues the complete +change resolves. For internal-only work with no classified result, delete all five classifier groups and place one applicable Technical details and Related references pair From 746e868054f057c21c56f9d88f4897ae9285285d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 13:02:09 +0100 Subject: [PATCH 08/13] Synchronize fallback with the approved release-note contract --- .github/pull_request_template.md | 152 ++++++++++++++++++++++--------- 1 file changed, 107 insertions(+), 45 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0100078..a4f0528 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,25 +14,58 @@ For internal-only work with no classified result, delete all five classifier groups and place one applicable Technical details and Related references pair directly after the marker. +Keep consumer instructions in the result prose and examples. Technical details +and references support but do not replace them. Keep version-specific migration +instructions in the PR/release notes, not repository migration guides. Cover +the complete delivered range from the identified consumer baseline, including +bundled changes and required intermediate operations. + +The full body remains the release note. A future Discord sender takes only the +pre-marker segment; announcement automation and date strategies are not +implemented here. Keep exactly one marker after the leading summary. + +Shared defaults are overridden by repository settings in the optional +.github/release.config.yml, then by explicitly supplied supported caller inputs. +Omitted caller inputs preserve repository settings. DefaultBump replaces +patch-only AutoPatching; it accepts patch, minor, or major, and its shared default is `patch`. +One explicit bump label overrides a valid effective DefaultBump. Invalid settings +and conflicting owned labels are errors, not reasons to select a fallback. + +Use only release:patch, release:minor, release:major, release:prerelease, and +release:skip for release decisions. Prerelease is a mode using an explicit or +default bump, not another level. Skip stands alone. + +Determine applicability from actual versioned release behavior, including native producer routes; +a missing settings file alone does not mean that a route is unmanaged. Delete the complete Release decisions block when the target route does not invoke Release Management, and apply no release:* labels. For an invoked route with Release set to No, keep only Release and Labels with release:skip. -Follow the canonical [MSX PR Format](https://msxorg.github.io/docs/Ways-of-Working/PR-Format/). +Verified producer candidate: MSXOrg/docs#209 at 48533dcc70d8bc344f8192bfad8de25a8fdaabe9. +The complete body below matches that candidate; this correspondence does not +claim that its draft has shipped. + +Follow the [complete MSX PR Format candidate](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Ways-of-Working/PR-Format.md#copy-the-complete-template). +Resolve [settings and caller overrides](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Capabilities/release-management/design.md#settings-and-caller-overrides). +Keep [release evidence](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Capabilities/release-management/spec.md#release-evidence) with its result. --> -{{ One or two short summary paragraphs that state what changes, who is affected, -and any required action. }} +{{ 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 }} -{{ One or two prose paragraphs that explain the outcome, affected readers, and -required action. }} +{{ 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. }} -{{ Optional interface example or compact table after the prose. Delete when it -does not help the reader act. }} +{{ 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 @@ -43,10 +76,12 @@ does not help the reader act. }} | --- | --- | --- | --- | | `{{ 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 consumer or template change, record the -release and source baseline, exact consumer action and verification, and the -compatible template repository and immutable commit. Delete when it does not -apply. }} +{{ 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. }}
@@ -61,11 +96,15 @@ apply. }} ## Removed: {{ Reader-facing result }} -{{ One or two prose paragraphs that explain the outcome, affected readers, and -required action. }} +{{ 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. }} -{{ Optional interface example or compact table after the prose. Delete when it -does not help the reader act. }} +{{ 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 @@ -76,10 +115,12 @@ does not help the reader act. }} | --- | --- | --- | --- | | `{{ 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 consumer or template change, record the -release and source baseline, exact consumer action and verification, and the -compatible template repository and immutable commit. Delete when it does not -apply. }} +{{ 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. }}
@@ -94,11 +135,15 @@ apply. }} ## New: {{ Reader-facing result }} -{{ One or two prose paragraphs that explain the outcome, affected readers, and -required action. }} +{{ 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. }} -{{ Optional interface example or compact table after the prose. Delete when it -does not help the reader act. }} +{{ 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 @@ -109,10 +154,12 @@ does not help the reader act. }} | --- | --- | --- | --- | | `{{ 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 consumer or template change, record the -release and source baseline, exact consumer action and verification, and the -compatible template repository and immutable commit. Delete when it does not -apply. }} +{{ 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. }}
@@ -127,11 +174,15 @@ apply. }} ## Changed: {{ Reader-facing result }} -{{ One or two prose paragraphs that explain the outcome, affected readers, and -required action. }} +{{ 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. }} -{{ Optional interface example or compact table after the prose. Delete when it -does not help the reader act. }} +{{ 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 @@ -142,10 +193,12 @@ does not help the reader act. }} | --- | --- | --- | --- | | `{{ 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 consumer or template change, record the -release and source baseline, exact consumer action and verification, and the -compatible template repository and immutable commit. Delete when it does not -apply. }} +{{ 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. }}
@@ -160,11 +213,15 @@ apply. }} ## Fixed: {{ Reader-facing result }} -{{ One or two prose paragraphs that explain the outcome, affected readers, and -required action. }} +{{ 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. }} -{{ Optional interface example or compact table after the prose. Delete when it -does not help the reader act. }} +{{ 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 @@ -175,10 +232,12 @@ does not help the reader act. }} | --- | --- | --- | --- | | `{{ 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 consumer or template change, record the -release and source baseline, exact consumer action and verification, and the -compatible template repository and immutable commit. Delete when it does not -apply. }} +{{ 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. }}
@@ -197,9 +256,12 @@ apply. }} - **Release:** {{ Yes or No }} - {{ Evidence from the artifact, route, and supported consumer contract. }} - **Version bump:** {{ Patch, Minor, or Major }} - {{ Compatibility evidence. - Delete this field when Release is No. }} + 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. - Delete this field when Release is No. }} + 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 9101c8becd2039e697f877c91a359edf1e3e6c48 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 13:03:43 +0100 Subject: [PATCH 09/13] Document pull request fallback adoption and local precedence --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9309d8b..aa42d12 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,9 @@ fallback behavior to work. The central [MSX documentation](https://msx.no/docs/) is the source for MSX standards and ways of working. + +The [pull request template](.github/pull_request_template.md) supplies a complete, +release-note-ready description scaffold and records its verified immutable +source. Repositories using this fallback need no configuration, code, or invocation changes; +authors fill in the inherited scaffold when opening a pull request. A repository's +local template retains precedence. Existing open pull request descriptions are not rewritten. From 342381e1b08d8b4315688446755a0eaa81134efe Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 13:20:05 +0100 Subject: [PATCH 10/13] Refresh producer compatibility and delivery evidence prompts --- .github/pull_request_template.md | 36 +++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a4f0528..0ac6599 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,7 +12,8 @@ change resolves. For internal-only work with no classified result, delete all five classifier groups and place one applicable Technical details and Related references pair -directly after the marker. +directly after the marker. The summary carries the adoption or explicit no-action +result; the supporting pair carries applicable evidence. Keep consumer instructions in the result prose and examples. Technical details and references support but do not replace them. Keep version-specific migration @@ -37,17 +38,22 @@ default bump, not another level. Skip stands alone. Determine applicability from actual versioned release behavior, including native producer routes; a missing settings file alone does not mean that a route is unmanaged. +Verify the immutable producer revision's settings and owned-label mapping before +using canonical signals. If the released interface differs, require a verified adapter +or producer/configuration migration with exact actions in that producer's +PR/release record. Unsupported signals block finalization and required decision +validation; do not apply ignored labels or treat the producer as unmanaged. Delete the complete Release decisions block when the target route does not invoke Release Management, and apply no release:* labels. For an invoked route with Release set to No, keep only Release and Labels with release:skip. -Verified producer candidate: MSXOrg/docs#209 at 48533dcc70d8bc344f8192bfad8de25a8fdaabe9. +Verified producer candidate: MSXOrg/docs#209 at 3d388e283c2e20d88d112b2951c4df857e955821. The complete body below matches that candidate; this correspondence does not claim that its draft has shipped. -Follow the [complete MSX PR Format candidate](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Ways-of-Working/PR-Format.md#copy-the-complete-template). -Resolve [settings and caller overrides](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Capabilities/release-management/design.md#settings-and-caller-overrides). -Keep [release evidence](https://github.com/MSXOrg/docs/blob/48533dcc70d8bc344f8192bfad8de25a8fdaabe9/src/docs/Capabilities/release-management/spec.md#release-evidence) with its result. +Follow the [complete MSX PR Format candidate](https://github.com/MSXOrg/docs/blob/3d388e283c2e20d88d112b2951c4df857e955821/src/docs/Ways-of-Working/PR-Format.md#copy-the-complete-template). +Resolve [settings and caller overrides](https://github.com/MSXOrg/docs/blob/3d388e283c2e20d88d112b2951c4df857e955821/src/docs/Capabilities/release-management/design.md#settings-and-caller-overrides). +Keep [release evidence](https://github.com/MSXOrg/docs/blob/3d388e283c2e20d88d112b2951c4df857e955821/src/docs/Capabilities/release-management/spec.md#release-evidence) with its result. --> {{ One or two short summary paragraphs that state what changes, why, who is @@ -70,7 +76,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 | | --- | --- | --- | --- | @@ -109,7 +117,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 | | --- | --- | --- | --- | @@ -148,7 +158,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 | | --- | --- | --- | --- | @@ -187,7 +199,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 | | --- | --- | --- | --- | @@ -226,7 +240,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 81d4ace2391f4e339d400503d63b54768064a6bd Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 22:15:45 +0100 Subject: [PATCH 11/13] Remove organization PR templates in favor of canonical guidance --- .github/CONTRIBUTING.md | 4 + .github/pull_request_template.md | 284 ------------------------------- README.md | 10 +- 3 files changed, 9 insertions(+), 289 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9ff7064..5e1b503 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,3 +2,7 @@ Follow the guidance in the central [MSX documentation](https://msx.no/docs/) when contributing to this repo. + +Write pull request descriptions using the canonical +[MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) instructions. +Do not add or copy GitHub PR-template files; keep the format in canonical guidance. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 0ac6599..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,284 +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 aa42d12..774bd95 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ fallback behavior to work. The central [MSX documentation](https://msx.no/docs/) is the source for MSX standards and ways of working. -The [pull request template](.github/pull_request_template.md) supplies a complete, -release-note-ready description scaffold and records its verified immutable -source. Repositories using this fallback need no configuration, code, or invocation changes; -authors fill in the inherited scaffold when opening a pull request. A repository's -local template retains precedence. Existing open pull request descriptions are not rewritten. +Pull request authors use the canonical +[MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) instructions. +This repository does not distribute GitHub pull request templates or provide a +central fallback. The format stays in canonical documentation, not repository +template files. From 990bfcbfd1275f80d58b3a9c51781f3873e22876 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 31 Oct 2026 22:48:08 +0100 Subject: [PATCH 12/13] Link PR authoring and file policy to their canonical owners --- .github/CONTRIBUTING.md | 5 ++++- README.md | 7 ++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5e1b503..519b40d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,4 +5,7 @@ when contributing to this repo. Write pull request descriptions using the canonical [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) instructions. -Do not add or copy GitHub PR-template files; keep the format in canonical guidance. +Use its +[complete description example](https://msx.no/docs/Ways-of-Working/PR-Format/#complete-description-example) +for the actual PR record. Do not add or copy GitHub PR-template files; follow the +[Repository Standard's file policy](https://msx.no/docs/Ways-of-Working/Repository-Standard/#no-pr-template-files). diff --git a/README.md b/README.md index 01c5508..df37418 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ folder. Pull request authors use the canonical [MSX PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/) instructions. -This repository does not distribute GitHub pull request templates or provide a -central fallback. The format stays in canonical documentation, not repository -template files. +This repository provides no local or organization-fallback PR-template files, +following the +[Repository Standard's file policy](https://msx.no/docs/Ways-of-Working/Repository-Standard/#no-pr-template-files). +The format stays in canonical documentation, not repository template files. From 3f3ce97f29da19d5fe3ad3cc540fa906cda8589b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 4 Nov 2026 13:13:40 +0100 Subject: [PATCH 13/13] State the community-defaults audience and supported jobs --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index df37418..caa23e4 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ community defaults. GitHub uses these files when an MSX repository does not define its own corresponding file. This repository must remain public for the fallback behavior to work. +This repository is for MSX repository maintainers and contributors. +Maintainers use GitHub's community-file fallback to share organization guidance. +Contributors use canonical MSX instructions to write pull request descriptions on GitHub. + The central [MSX documentation](https://msx.no/docs/) is the source for MSX standards and ways of working.