|
| 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