Document that PR descriptions must not be hard-wrapped#2437
Open
Sergio0694 wants to merge 1 commit into
Open
Conversation
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>
Sergio0694
added
documentation
manodasanW
approved these changes
Jun 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add an explicit formatting rule to the
pull-requestskill stating that PR descriptions must not be hard-wrapped like commit messages, and reflow the skill's own example descriptions so they model single-line paragraphs.Motivation
PR descriptions are not commit messages. GitHub-Flavored Markdown renders a single newline inside a paragraph as a hard
<br>line break, so wrapping a description at a fixed column width (as you would for a commit message body) makes it render with line breaks mid-sentence. Thepull-requestskill previously had no rule against this, and its own example descriptions were themselves hard-wrapped, actively modeling the bad pattern. This recently led to a PR being created with a commit-style hard-wrapped description that rendered poorly. This change documents the correct behavior so it doesn't happen again.Changes
.github/skills/pull-request/SKILL.md: added a "do not hard-wrap text like a commit message" rule to the description formatting rules, explaining the GitHub<br>rendering behavior. Also reflowed the in-skill## Motivationtemplate text and the example PR description so each paragraph is a single continuous line, rather than demonstrating commit-style wrapping.