Skip to content

Commit 1247c91

Browse files
Marius StorhaugMarius Storhaug
authored andcommitted
Align release authoring template and thin skill
1 parent 9429621 commit 1247c91

3 files changed

Lines changed: 120 additions & 63 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 106 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,136 @@
11
<!--
2-
This is the final content-control plan for the pull request author. The automated release process reuses this title
3-
and description as the GitHub Release notes by default; it does not create a separate release-note document. Format
4-
the title, description, and selected version label for the people who use the released artifact. See
5-
docs/content/guides/formatting-release-note-prs.md and the psmodule-release-note-authoring skill. Delete headings
6-
that do not apply. Remove every placeholder and comment before marking the pull request ready.
2+
Follow docs/content/guides/formatting-release-note-prs.md and the shared MSX PR format.
3+
The release-bound title and complete description are the authored release record. Cover the entire delivered range,
4+
including prior merged or skipped deltas entering the artifact. Write an audience-first title without an icon/type prefix.
5+
Keep only applicable classifier sections in the order shown; repeat a section for each distinct result.
6+
Put complete upgrade instructions and necessary old-to-new examples in each result's prose. PRs/diffs are optional depth.
7+
Keep supporting blocks scoped to their result. For internal-only work without a classified result, place them after the marker.
8+
Remove placeholders, empty blocks, and authoring comments; keep the ANNOUNCEMENT STOP marker.
79
-->
810

9-
<One concise paragraph: what users receive and why it matters.>
11+
{{ Concise summary: what changes, why, who is affected, and required action or an explicit no-action result.
12+
Lead with breaking impact when applicable. }}
1013

11-
## New: <capability>
14+
<!-- ANNOUNCEMENT STOP -->
1215

13-
<What users can now do and the result they get.>
16+
## Breaking: {{ Reader-facing result }}
1417

15-
## Changed: <behavior>
18+
{{ Explain the result, rationale, affected consumers, compatibility, and verified release/source baseline.
19+
Give exact adoption or migration actions, prerequisites, order, and verification. Include necessary old-to-new examples.
20+
Require intermediate installations or runs only when needed. State the no-action result for unaffected consumers. }}
1621

17-
<What users experience differently.>
22+
<details>
23+
<summary>Technical details</summary>
24+
25+
{{ Implementation, validation commands and results, compatibility evidence, and standards alignment for this result.
26+
When an integration template applies, identify its repository and verified immutable compatible commit,
27+
producer-source compatibility evidence, and linked template work or a justified no-change result. }}
1828

19-
## Fixed: <problem>
29+
</details>
2030

21-
<What now works and how users benefit.>
31+
<details>
32+
<summary>Related references</summary>
2233

23-
## Breaking Changes
34+
- References Owner/Repository#123
2435

25-
<What no longer works, who is affected, and the compatible replacement.>
36+
</details>
2637

27-
## Adopting this release
38+
## Removed: {{ Reader-facing result }}
2839

29-
1. <First action from the currently supported version, reference, configuration, or invocation.>
30-
2. <Next action and how the user verifies the outcome.>
40+
{{ Explain what is removed and why, affected consumers, compatibility, and verified release/source baseline.
41+
Give the supported replacement, exact actions or explicit no-action result, prerequisites, order, and verification.
42+
Keep required transition examples here; require intermediate installations or runs only when needed. }}
3143

32-
<Or: No configuration, code, or invocation change is required. Update to this version normally.>
44+
<details>
45+
<summary>Technical details</summary>
3346

34-
## Release impact
47+
{{ Implementation, validation commands and results, compatibility and standards evidence for this result.
48+
Include applicable verified immutable template evidence and linked work or a justified no-change result. }}
3549

36-
- **Configured label:** `<label that selects this release>`
37-
- **SemVer change:** `<Major | Minor | Patch>`
38-
- **Version transition:** `<current published version> -> <planned release version>`
39-
- **Release name:** `<planned release version>`
50+
</details>
4051

41-
<!--
42-
For a skip/no-release label, say that no artifact is published and no version transition occurs.
43-
For a prerelease, state the selected bump and that it is not the latest stable version.
44-
-->
52+
<details>
53+
<summary>Related references</summary>
54+
55+
- References Owner/Repository#123
56+
57+
</details>
58+
59+
## New: {{ Reader-facing result }}
60+
61+
{{ Explain what consumers gain and why, applicability, compatibility, and verified release/source baseline.
62+
Distinguish optional feature use from required upgrade actions. Give exact actions or an explicit no-action result,
63+
prerequisites, order, verification, and any required intermediate installations or runs. }}
64+
65+
<details>
66+
<summary>Technical details</summary>
67+
68+
{{ Implementation, validation commands and results, compatibility and standards evidence for this result.
69+
Include applicable verified immutable template evidence and linked work or a justified no-change result. }}
70+
71+
</details>
72+
73+
<details>
74+
<summary>Related references</summary>
75+
76+
- References Owner/Repository#123
77+
78+
</details>
79+
80+
## Changed: {{ Reader-facing result }}
81+
82+
{{ Explain what changes and why, affected consumers, compatibility, and verified release/source baseline.
83+
Give exact adoption or migration actions or an explicit no-action result, prerequisites, order, and verification.
84+
Keep required transition examples here; require intermediate installations or runs only when needed. }}
85+
86+
<details>
87+
<summary>Technical details</summary>
88+
89+
{{ Implementation, validation commands and results, compatibility and standards evidence for this result.
90+
Include applicable verified immutable template evidence and linked work or a justified no-change result. }}
91+
92+
</details>
93+
94+
<details>
95+
<summary>Related references</summary>
96+
97+
- References Owner/Repository#123
98+
99+
</details>
100+
101+
## Fixed: {{ Reader-facing result }}
102+
103+
{{ Explain what works correctly and why it matters, affected consumers, compatibility, and verified release/source baseline.
104+
Give exact actions or an explicit no-action result, prerequisites, order, verification, and any required intermediate
105+
installations or runs. Keep necessary old-to-new examples in this prose. }}
45106

46-
---
47107
<details>
48108
<summary>Technical details</summary>
49109

50-
<Implementation approach, compatibility evidence, validation, and standards alignment.>
110+
{{ Implementation, validation commands and results, compatibility and standards evidence for this result.
111+
Include applicable verified immutable template evidence and linked work or a justified no-change result. }}
51112

52113
</details>
53114

54115
<details>
55-
<summary>Relevant issues (or links)</summary>
116+
<summary>Related references</summary>
117+
118+
- References Owner/Repository#123
56119

57-
- Resolves Owner/Repository#123
120+
</details>
58121

59-
### Related work
122+
<!--
123+
Keep Release decisions only when the target route invokes Release Management.
124+
Use the actual publisher's configured labels/defaults; this template does not migrate them.
125+
For no release, keep only Release and Labels, and state that no artifact or version is produced.
126+
The publisher resolves final numeric coordinates; do not predict them.
127+
-->
128+
<details>
129+
<summary>Release decisions</summary>
60130

61-
- References Owner/Repository#456
131+
- **Release:** {{ Yes or No, with evidence from the artifact, target route, and supported consumer contracts. }}
132+
- **Version bump:** {{ Patch, Minor, or Major, with verified semantic impact and the configured decision source. Omit for No. }}
133+
- **Mode:** {{ Stable or Prerelease, with route or override evidence. Omit for No. }}
134+
- **Labels:** {{ Exact applied labels, or None when effective configuration supplies the decision without an override. }}
62135

63136
</details>

‎.github/plugin/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ documentation site.
4141
The
4242
[`psmodule-release-note-authoring`](./psmodule/skills/psmodule-release-note-authoring/SKILL.md)
4343
skill formats pull request titles, descriptions, and labels as user-facing
44-
release notes with adoption steps and verified version transitions.
44+
release records with complete upgrade instructions, verified semantic impact,
45+
and publisher-resolved versions.
4546
Verify the installation with:
4647

4748
```console
Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,21 @@
11
---
22
name: psmodule-release-note-authoring
3-
description: Format pull request titles, descriptions, and labels as user-facing release notes with adoption steps and a verified version transition.
3+
description: Author or review pull requests as complete consumer upgrade records using the shared release-note guidance.
44
---
55

66
# Format release-note pull requests
77

8-
Use this skill when formatting, rewriting, or reviewing a pull request whose title and description will be published
9-
as release notes. This skill controls the author-facing pull request message; it does not create separate release
10-
notes. Read the [pull-request formatting guide](../../../../../docs/content/guides/formatting-release-note-prs.md)
11-
before editing the pull request. That guide owns the release-note structure and the user-facing writing rules.
8+
Use when formatting, rewriting, or reviewing a pull request whose title and complete description become release
9+
notes. First read the [authoring guide](../../../../../docs/content/guides/formatting-release-note-prs.md);
10+
it owns the release-record content, replay check, evergreen-documentation boundary, and validation.
11+
The linked [MSX PR format](https://msx.no/docs/Ways-of-Working/PR-Format/) owns the shared title and description structure.
1212

13-
## Operating contract
13+
If the repository-relative guide is unavailable from an installed plugin, read its
14+
[published page](https://psmodule.io/docs/guides/formatting-release-note-prs/) instead.
1415

15-
1. Identify the artifact users consume, its current published version or reference, its configured version-label
16-
mapping, and the users affected by the change.
17-
2. Format the title, description, and selected label around one user outcome. Group description changes by what users
18-
experience, not by files or implementation activity.
19-
3. Include an ordered `Adopting this release` section for every affected user. State that normal updating is sufficient
20-
when no configuration, code, or invocation change is required.
21-
4. Verify the configured label, SemVer effect, current published version, and planned release version together. Refresh
22-
the numeric transition before the pull request is ready if another release may have changed the baseline.
23-
5. Put implementation, validation, compatibility evidence, and standards alignment in the final `Technical details`
24-
block. Preserve the MSX `Relevant issues (or links)` block at the end.
25-
6. Rework the title, adoption path, and release impact whenever the diff, selected label, or compatibility impact
26-
changes. Do not leave placeholders, stale version values, or reviewer-oriented prose in the published body.
16+
## Agent-specific contract
2717

28-
## Stop conditions
29-
30-
Stop and report when the release label mapping, current published version, artifact consumer, or compatibility impact
31-
cannot be determined. Do not infer a version transition from conventional label names, describe routine adoption as a
32-
migration, or claim that no user action is needed without inspecting the delivered behavior.
33-
34-
## References
35-
36-
- [Formatting release-note pull requests](../../../../../docs/content/guides/formatting-release-note-prs.md)
37-
- [Versioning and releases](../../../../../docs/content/guides/versioning-and-releases.md)
38-
- [MSX PR format](https://msx.no/docs/Ways-of-Working/PR-Format/)
18+
- Read the target repository's instructions and PR template before editing its metadata.
19+
- Apply the guide's authoring and replay checks to the full delivered range.
20+
- Report the edited PR URL, relevant baseline, verified impact, and validation outcomes to the owning session.
21+
- Stop and report when the cited guidance or required source evidence is unavailable; identify the evidence gap.

0 commit comments

Comments
 (0)