From 07874804881bfc57aaf92eb732ffe293f558b934 Mon Sep 17 00:00:00 2001 From: Sergio Pedri Date: Fri, 12 Jun 2026 13:37:34 -0700 Subject: [PATCH] Document PR descriptions must not be hard-wrapped PR descriptions are not commit messages: GitHub-Flavored Markdown renders single newlines within a paragraph as hard line breaks, so commit-style hard-wrapping makes descriptions render broken with line breaks mid-sentence. Add an explicit formatting rule to the pull-request skill and reflow the in-skill example descriptions so they model single-line paragraphs instead of demonstrating the bad pattern. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/skills/pull-request/SKILL.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/.github/skills/pull-request/SKILL.md b/.github/skills/pull-request/SKILL.md index 7cb24043d5..f2dff2632c 100644 --- a/.github/skills/pull-request/SKILL.md +++ b/.github/skills/pull-request/SKILL.md @@ -42,10 +42,7 @@ Brief summary of what this PR does (1-3 sentences). ## Motivation -Explain *why* these changes are being made. What problem do they solve? -What improvement do they bring? If the user provided motivation when -asking for the PR, use that. Otherwise, infer from the diff, commit -messages, and code comments. +Explain *why* these changes are being made. What problem do they solve? What improvement do they bring? If the user provided motivation when asking for the PR, use that. Otherwise, infer from the diff, commit messages, and code comments. ## Changes @@ -57,6 +54,7 @@ List the key changes in the PR: ``` **Formatting rules:** +- **Do not hard-wrap text like a commit message.** A PR description is not a commit message: never break paragraphs or bullet points at a fixed column width (e.g. 72 characters). Write each paragraph and each bullet point as a single continuous line and let it soft-wrap. GitHub-Flavored Markdown renders a single newline inside a paragraph as a hard `
` line break, so commit-style wrapping makes the description render with line breaks mid-sentence. Only use blank lines to separate paragraphs, list items, and sections. - Use clean, standard markdown (no HTML entities, no non-printable characters) - Use backticks for file paths, type names, and code references - Keep bullet points concise @@ -128,15 +126,11 @@ Remove-Item $bodyFile ```markdown ## Summary -Add comprehensive Copilot instructions documenting the CsWinRT 3.0 -architecture, build pipeline, and coding conventions. +Add comprehensive Copilot instructions documenting the CsWinRT 3.0 architecture, build pipeline, and coding conventions. ## Motivation -The CsWinRT 3.0 codebase is complex, with multiple interrelated build -tools and a multi-phase build pipeline. Having detailed Copilot -instructions helps contributors and AI assistants understand the -architecture and make correct changes without extensive ramp-up time. +The CsWinRT 3.0 codebase is complex, with multiple interrelated build tools and a multi-phase build pipeline. Having detailed Copilot instructions helps contributors and AI assistants understand the architecture and make correct changes without extensive ramp-up time. ## Changes