Repository navigation
PR authors use canonical guidance without repository templates - #8
Marius Storhaug (MariusStorhaug) wants to merge 13 commits into
Conversation
Guide inherited pull request bodies through the synchronized audience-facing format while keeping classified sections, supporting details, and release metadata optional.\n\nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Use a channel-neutral cutoff name for announcement tooling. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Keep the inherited template aligned with the pinned source contract. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Apply the user-approved marker across the synchronized public contract. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Align the inherited template with the finalized public URL and route-scoped release guidance. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Embed the canonical copy-ready body, including scoped evidence and conditional release decisions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Retain the synchronized closing-keyword rule in the inherited template guidance. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🔵 Needs a closer look
The upstream prerequisite remains unmerged and required hosted validation is missing, so an owner must independently verify these readiness gates beyond this diff review.
No open issues 🎉
What changed in this PR
Expands the organization-wide pull request fallback into an audience-first, release-note-ready scaffold aligned with the pinned, unmerged MSX documentation candidate.
Changes:
- Adds five ordered result groups with adoption instructions, validation evidence, and related references.
- Adds one announcement boundary and conditional release-decision guidance without implementing release automation.
- Clarifies that inheritance requires no configuration changes, local templates retain precedence, and existing descriptions remain unchanged.
| File | Description |
|---|---|
README.md |
Documents the expanded scaffold and fallback behavior. |
.github/pull_request_template.md |
Provides the complete scaffold, pinned source references, and authoring guidance. |
Review effort: Balanced
|
Kept this PR draft in response to the review summary. The native upstream prerequisite is MSXOrg/docs#226 and remains open; the pinned MSXOrg/docs#209 candidate has not landed. At 9101c8b, the only hosted check is the successful copilot-pull-request-reviewer run, not template validation. The no-existing-CI finding and its owning readiness requirement are recorded separately in #11. No pipeline or ruleset change is approved through this PR, and local checks are not reported as nonexistent hosted validation. The description now records the complete summary concerns, not just the zero-inline result. |
There was a problem hiding this comment.
🔵 Needs a closer look
Unmerged MSXOrg/docs#209, open MSXOrg/docs#226, and missing hosted validation tracked in #11 require owner verification of prerequisite and readiness gates before merge.
No open issues 🎉
Review effort: Balanced
|
The material source refresh is now verified at 342381e against MSXOrg/docs candidate 3d388e283c2e20d88d112b2951c4df857e955821. The new review summary still identifies the real source prerequisite and missing hosted validation; those concerns remain open. Kept the PR draft, recorded the current-head review and complete plan/convergence evidence in its description, and made no pipeline or ruleset change. The old 9101c8b review is not used as proof for the refreshed code. |
|
The producer HEAD later advanced to 1ececb2bd9f1680c87cec15a45ac927a554fce9c. Live comparison from 3d388e283c2e20d88d112b2951c4df857e955821 shows exactly one changed file outside the shared fallback contract: the VS Code extension framework design. PR Format, Release Management design/spec, and Definition of Ready for Review are unchanged. The verified 3d388e28 correspondence therefore remains current for the shared contract, and 342381e remains the reviewed fallback head. No extra template change or review round is needed for this unrelated producer edit; source and hosted-readiness blockers remain open. |
There was a problem hiding this comment.
🔵 Needs a closer look
The canonical no-template handoff in MSXOrg/docs#209/#226 remains pending, and compatibility with the separately owned #12 validator requires coordinated human confirmation.
No open issues 🎉
Review effort: Balanced
|
The user-directed no-template removal is pushed and verified at 81d4ace. The complete review summary is handled by retaining draft state for the pending canonical #209/#226 no-file handoff and coordinated #12 validator compatibility. The CI owner has the exact sole deletion and candidate head. No template file remains, no earlier scaffold review is reused, and no local check or successful reviewer job is presented as hosted code validation or independent approval. |
There was a problem hiding this comment.
🔵 Needs a closer look
The change depends on unmerged MSXOrg/docs#209, requiring maintainer confirmation of publication and compatibility with the separately owned #12 validator before landing.
No open issues 🎉
Review effort: Balanced
|
Kept the PR draft in response to the full current-head summary. The immutable no-file authority bc03a5992615f65d1d5346dc48e7506e80b8b6ca is now verified, and the separate #12 owner confirms source-bound local compatibility for 990bfcb against 0c67251. That does not make the ready-but-unmerged docs prerequisite landed, attach code-validation CI to #8, authorize required-check enforcement, or supply independent record approval. The description separates those facts from the successful automated diff review; no live governance or merge action was taken. |
Write MSX pull request descriptions from canonical PR-format guidance instead of an automatically populated organization template. This change removes the central PR template without creating a replacement and links the contribution guide to the complete actual-record example.
Other community defaults and issue forms remain unchanged. Existing PR descriptions are not erased or rewritten; no runtime, configuration, or intermediate-upgrade action is required.
Removed: Organization PR-template distribution
The organization no longer supplies a GitHub PR-template file. Authors opening new pull requests write the actual title and description using canonical MSX PR Format instructions and its complete description example. Do not replace the removed fallback with root,
.github, ordocstemplate files or aPULL_REQUEST_TEMPLATEdirectory. Repository Standard owns that file policy; PR Format owns the actual record's structure, complete source coverage, consumer actions, and evidence.The sole actual template in this candidate was
.github/pull_request_template.md, and it is deleted. The README and contribution guide link to the separately owned file policy and authoring guidance rather than an inherited or copied scaffold. Other community defaults, issue forms, media, client routes, repository-specific contribution instructions, and product integration templates are unaffected. To verify adoption, inspect the candidate tree for zero GitHub PR-template files and write a new PR description from canonical guidance rather than expecting an organization-provided body.Technical details
Exact candidate and scoped comparison: MSXOrg/.github@990bfcbfd1275f80d58b3a9c51781f3873e22876, compared with the current default-branch base
0c67251812ea306543f3a14ab473ae357cfb76ac. The branch refresh preserves the already-landed shared-media paragraph, assets, and text/binary handling from #9. Its only net changes are the template deletion and directly coupled README/contribution pointers. Earlier distribution commits are retained as history, but their template does not exist in the candidate. No replacement file, generator, copied scaffold, or local duplicate is added.Verified canonical correspondence: The owning source is MSXOrg/docs#209 at
bc03a5992615f65d1d5346dc48e7506e80b8b6ca. It has been independently read back: its untruncated source tree contains 298 entries and zero GitHub PR-template files, required documentation checks succeed at that exact head, and an exact-head approval exists. The source PR is ready for human review but not merged; native Task MSXOrg/docs#226 remains open. This correspondence is not a shipped-source or readiness claim.The directly coupled repository pointers use canonical published URLs. Their new policy/example anchors are verified at the immutable candidate; publication of those new headings still depends on the source PR landing. This draft does not claim the current published site already contains the unmerged revision.
.github/pull_request_template.mdREADME.mdand.github/CONTRIBUTING.mdLocal verification: At this refreshed candidate, 42 tracked files are inspected and zero tracked/on-disk GitHub PR-template variants remain. The no-template assertion failed before deletion; the direct file-policy pointer check failed before the source-ownership update. Both pass after the changes. There are two correctly owned file-policy pointers and one complete actual-record-example pointer, with no obsolete copy-template or deleted-file link. The full current-base changed-file inventory contains only
.github/pull_request_template.md,README.md, and.github/CONTRIBUTING.md. Accepted main content is preserved unchanged.git --no-pager diff --check 0c67251812ea306543f3a14ab473ae357cfb76ac..HEADpasses.The shared Markdown configuration fetched at
bc03a5992615f65d1d5346dc48e7506e80b8b6cavalidates both changed guides with zero issues, and the final actual PR body also passes Markdown lint. No new toolchain is added to this source-removal PR.Implementation-plan progress: All scoped steps in #10 are implemented and verified: no-template inventory, failing baseline, deletion, coupled documentation, current-main refresh, exact immutable source readback, ownership/anchor alignment, and the fresh current-head review. Ordinary commits preserve prior work without amendments. The Task remains open until its reviewed delivery lands; completed author-side work does not satisfy the still-open source/CI/enforcement gates.
Current-head review: The explicit Copilot round at
990bfcbfd1275f80d58b3a9c51781f3873e22876exited0, with zero inline comments and zero unresolved threads. The complete summary reports no diff issues but requires maintainer confirmation of the unmerged MSXOrg/docs#209 source/publication and separately owned #12 validator compatibility before landing. Those readiness concerns are not dismissed as a clean diff result. The only hosted check on this candidate is the successfulcopilot-pull-request-reviewerjob, not code-validation CI or independent approval.Source-bound validator compatibility: The separate #12 owner reverified both actual changed Markdown contents at this exact source head against base
0c67251812ea306543f3a14ab473ae357cfb76acusing its literal-content, no-inline shared-rule checker. The central template is the sole deletion and the complete source inventory has zero PR-template files. This is reported source-bound local compatibility, not a hosted #8 check or record-quality approval. The owner did not alter this checkout, and this PR does not edit its validator, workflow, or tests.Remaining readiness gates: This PR stays draft. Native source Task MSXOrg/docs#226 has not landed, and source PR MSXOrg/docs#209 is ready but unmerged. The separate #12 code-validation delivery is still draft/unmerged; its stable check is
Organization defaults validationfrom GitHub Actions integration15368. That check is not yet attached to this candidate, and the live main ruleset names no required-status-check rule. Local compatibility, a ready upstream PR, and a successful reviewer job do not replace source landing, actual hosted validation, required enforcement, or independent review. No live enforcement, release label, ruleset, tag, auto-merge, merge, or publication action is included.Release applicability: This community-default route has no versioned artifact publication. It carries neither a release-decision block nor release labels and does not invent a consumer-publication baseline. The current-main comparison above is scoped implementation evidence, not substituted release coverage.
Issue convergence: The sweep is scoped to this repository's open template-distribution and validation work. This PR closes only #10. #11 and its #12 validation delivery remain separate; no additional issue is fully delivered by this diff. Already-delivered community/context/media work and separate pre-commit/feature-intake Tasks are unchanged.
Related references