diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 13e45de..0100078 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,206 @@ - + - + + +{{ One or two short summary paragraphs that state what changes, who is affected, +and any required action. }} + + + +## Breaking: {{ 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 + +
+ +## Removed: {{ 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 + +
+ +## New: {{ 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 + +
+ +## 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
-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. + 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. }}