📖 [Docs]: Pull requests now control user-ready release notes

[Marius Storhaug (MariusStorhaug)]

Contributors now have a final pull-request content-control plan for the title, description, and label that automated releases reuse as user-facing GitHub Release notes. The guide governs those three fields before review; it is not a separate release-note artifact.

New: Pull-request formatting guide

The documentation now gives authors one artifact-neutral format for PowerShell modules, reusable workflows, GitHub Actions, libraries, services, and infrastructure modules. It keeps the user outcome and the technical delivery evidence distinct while making the release message an intentional author decision.

New: Release-note authoring skill and template

The psmodule-release-note-authoring skill and the repository pull-request template now guide authors through the same content-control plan while the pull request is being written. They require an explicit adoption path and prevent the published body from retaining placeholders or reviewer-oriented prose.

Changed: PR-based release notes show the complete transition

The release configuration guide and versioning guide now establish that automation reuses the pull request title as the release-note heading and its description as the body by default. Authors record the configured label, SemVer effect, current published version, and planned released version together with the user adoption path.

Adopting this release

1. Update the Process-PSModule documentation or the psmodule plugin when this change is available to your repository.
2. Use the new guide, skill, or pull-request template when preparing a release-bound pull request; format the user outcome, ordered adoption steps, and version transition before the technical details.

No caller workflow, module configuration, command invocation, or existing release behavior changes in this documentation release.

Release impact

• Configured label: NoRelease
• SemVer change: No release.
• Version transition: No artifact is published and no version transition occurs.
• Release name: Not applicable.

---

Technical details

• Adds docs/content/guides/formatting-release-note-prs.md, exposes it in the Guides navigation, and links the release configuration and versioning guides to it.
• Defines the guide as the final content-control plan for the pull-request title, description, and configured version label. It explicitly separates this authoring responsibility from the automated reuse of finalized content as a release note.
• Adds .github/PULL_REQUEST_TEMPLATE.md and the thin psmodule-release-note-authoring plugin skill; both defer shared policy to the documentation guide.
• Updates the PR release-notes example to use a user-facing title, adoption section, and release-impact statement.
• Updates the versioning guide with the default title, body, and release-name behavior verified against PSModule/Release-GHRepository v2.0.3.
• The guide uses configured labels rather than assuming the current Process-PSModule defaults, so it remains correct for repositories with custom label mappings and the pending owned-label change.
• Standards and framework alignment:

Changed surface	Standards checked	Framework docs checked	Result
docs/content/guides/**	MSX guide and PR formats	Versioning and release-note settings	Aligned
docs/zensical.toml	Zensical navigation	Documentation-site structure	Aligned
.github/PULL_REQUEST_TEMPLATE.md	MSX PR format	PR release-note contract	Aligned
.github/plugin/**	Plugin skill authoring guidance	Process-PSModule documentation	Aligned

Relevant issues (or links)

Related work

• References Make release impact and user adoption explicit in PR release notes MSXOrg/docs#202

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
CSS	Pass ✅
CSS_PRETTIER	Pass ✅
GITHUB_ACTIONS	Pass ✅
GITHUB_ACTIONS_ZIZMOR	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
HTML	Pass ✅
JAVASCRIPT_ES	Pass ✅
JAVASCRIPT_PRETTIER	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter