From d344a4c425dec52edeb8c4a0c97d0241dd986cb3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 13 Sep 2026 10:53:22 +0200 Subject: [PATCH 1/7] 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 2/7] 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 6/7] 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 7/7] 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