Skip to content

Commit 517607b

Browse files
Add release note authoring skill
Co-authored-by: GitHub Copilot <198982749+Copilot@users.noreply.github.com>
1 parent 969f373 commit 517607b

3 files changed

Lines changed: 102 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!--
2+
This title and description become the GitHub Release notes by default. Write for the people who use the released
3+
artifact. See docs/content/guides/writing-release-note-prs.md and the psmodule-release-note-authoring skill.
4+
Delete headings that do not apply. Remove every placeholder and comment before marking the pull request ready.
5+
-->
6+
7+
<One concise paragraph: what users receive and why it matters.>
8+
9+
## New: <capability>
10+
11+
<What users can now do and the result they get.>
12+
13+
## Changed: <behavior>
14+
15+
<What users experience differently.>
16+
17+
## Fixed: <problem>
18+
19+
<What now works and how users benefit.>
20+
21+
## Breaking Changes
22+
23+
<What no longer works, who is affected, and the compatible replacement.>
24+
25+
## Adopting this release
26+
27+
1. <First action from the currently supported version, reference, configuration, or invocation.>
28+
2. <Next action and how the user verifies the outcome.>
29+
30+
<Or: No configuration, code, or invocation change is required. Update to this version normally.>
31+
32+
## Release impact
33+
34+
- **Configured label:** `<label that selects this release>`
35+
- **SemVer change:** `<Major | Minor | Patch>`
36+
- **Version transition:** `<current published version> -> <planned release version>`
37+
- **Release name:** `<planned release version>`
38+
39+
<!--
40+
For a skip/no-release label, say that no artifact is published and no version transition occurs.
41+
For a prerelease, state the selected bump and that it is not the latest stable version.
42+
-->
43+
44+
---
45+
<details>
46+
<summary>Technical details</summary>
47+
48+
<Implementation approach, compatibility evidence, validation, and standards alignment.>
49+
50+
</details>
51+
52+
<details>
53+
<summary>Relevant issues (or links)</summary>
54+
55+
- Resolves Owner/Repository#123
56+
57+
### Related work
58+
59+
- References Owner/Repository#456
60+
61+
</details>

.github/plugin/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ The
3838
[`psmodule-skill-authoring`](./psmodule/skills/psmodule-skill-authoring/SKILL.md)
3939
skill keeps plugin skills thin and points shared authoring guidance to the
4040
documentation site.
41+
The
42+
[`psmodule-release-note-authoring`](./psmodule/skills/psmodule-release-note-authoring/SKILL.md)
43+
skill writes release-bound pull requests as user-facing release notes with
44+
adoption steps and verified version transitions.
4145
Verify the installation with:
4246

4347
```console
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: psmodule-release-note-authoring
3+
description: Write or review release-bound pull requests as user-facing release notes with adoption steps and a verified version transition.
4+
---
5+
6+
# Author release-note pull requests
7+
8+
Use this skill when authoring, rewriting, or reviewing a pull request whose title and description will be published as
9+
release notes. Read the [release-note pull request guide](../../../../../docs/content/guides/writing-release-note-prs.md)
10+
before editing the pull request. That guide owns the release-note structure and the user-facing writing rules.
11+
12+
## Operating contract
13+
14+
1. Identify the artifact users consume, its current published version or reference, its configured version-label
15+
mapping, and the users affected by the change.
16+
2. Write the title and leading paragraph around the user outcome. Group changes by what users experience, not by files
17+
or implementation activity.
18+
3. Include an ordered `Adopting this release` section for every affected user. State that normal updating is sufficient
19+
when no configuration, code, or invocation change is required.
20+
4. Verify the configured label, SemVer effect, current published version, and planned release version together. Refresh
21+
the numeric transition before the pull request is ready if another release may have changed the baseline.
22+
5. Put implementation, validation, compatibility evidence, and standards alignment in the final `Technical details`
23+
block. Preserve the MSX `Relevant issues (or links)` block at the end.
24+
6. Rework the title, adoption path, and release impact whenever the diff, selected label, or compatibility impact
25+
changes. Do not leave placeholders, stale version values, or reviewer-oriented prose in the published body.
26+
27+
## Stop conditions
28+
29+
Stop and report when the release label mapping, current published version, artifact consumer, or compatibility impact
30+
cannot be determined. Do not infer a version transition from conventional label names, describe routine adoption as a
31+
migration, or claim that no user action is needed without inspecting the delivered behavior.
32+
33+
## References
34+
35+
- [Writing release-note pull requests](../../../../../docs/content/guides/writing-release-note-prs.md)
36+
- [Versioning and releases](../../../../../docs/content/guides/versioning-and-releases.md)
37+
- [MSX PR format](https://msx.no/docs/Ways-of-Working/PR-Format/)

0 commit comments

Comments
 (0)