Skip to content

Pull request guidance uses audience-first release notes - #209

Draft
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
sync-pr-format-standard
Draft

Pull request guidance uses audience-first release notes#209
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
sync-pr-format-standard

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Sep 13, 2026

Copy link
Copy Markdown
Member

Contributors now have one audience-first pull request format across the MSX documentation set. Titles state one reader-facing result, descriptions use ordered change sections and scoped evidence, and release decisions appear only on routes that invoke Release Management. The canonical page now includes a complete copy-ready description template.

Changed: Pull request authoring guidance

PR authors now identify readers, inspect the complete change, keep claims evidence-based, select relevant news, and group related results before writing. The format uses the approved announcement boundary, ordered change classifiers, and section-scoped technical details and references.

The complete template includes every classifier in the required order, one scoped technical-details and references pair for each result, standards and framework alignment fields, applicable release evidence, and the conditional release-decision block. Its instructions cover reader-facing, internal-only, release-managed, and unmanaged pull requests without leaving empty sections.

Workflow, readiness, repository, dependency, fleet, and release-management pages defer title and description structure to PR Format while retaining their own implementation rules. The repository contribution guide explains the inherited organization template, points to the canonical MSX standard, and links directly to the complete description template.

Technical details

The canonical src/docs/Ways-of-Working/PR-Format.md path, Zensical navigation entry, and plugin pointer remain unchanged. This repository has no Release Management workflow invocation, so this pull request intentionally carries no release block or release:* label.

Changed surface Standards checked Framework docs checked Result
PR format and complete description template PR Format, Markdown, and Documentation Model None (no framework-specific docs) Aligned
Contribution guide and inherited-template link Contribution Workflow and PR Format None (no framework-specific docs) Aligned
Contribution, review, readiness, branching, fleet, and repository workflow pages Ways of Working None (no framework-specific docs) Aligned
Release Management specification and design Release Management None (no framework-specific docs) Aligned
Dependency, automation, and natural-language dependants Owning capability and coding standards None (no framework-specific docs) Aligned

Validation passed: generated documentation indexes; 127-file local-link scan; 7 cross-repository links across 131 files; all 64 Pester tests in 6 suites; clean Zensical build; whitespace check; representative managed and unmanaged PR-description scenarios; and a template-contract check covering marker count, classifier order, scoped blocks, and release fields.

Related references

Replace the icon-and-type schema with audience-first titles, evidence-based descriptions, and route-conditional MSX release decisions. Document the inherited organization template and refresh navigation and anchor references.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep workflow mechanics in their owning pages, make release decisions conditional on route invocation, and preserve campaign identity without polluting reader-facing pull request titles.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace the channel-specific Slack boundary with the approved announcement marker while preserving exact once-only placement.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant