Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 6cf9536

Browse filesBrowse files
ibetitsmikeibetitsmike
authored
docs(.agents/skills/pull-requests): warn against hard-wrapping PR bodies (#25141)
PR bodies copied from a commit message body keep their 72/80-column hard wraps, and GitHub renders those as ragged-right line breaks instead of soft-wrapped paragraphs (e.g. the original body of #25130, fixed in this branch). The rule already exists in `.claude/docs/PR_STYLE_GUIDE.md`, but it is buried in a 200-line style guide and easy to miss when an agent is mechanically running `gh pr create`. This change adds a short "Body Formatting" section directly to `.agents/skills/pull-requests/SKILL.md`, which is the proximate context loaded at PR-write time, and explicitly tells callers to unwrap commit-message paragraphs before reusing them as a PR body. > Generated by Coder Agents on behalf of the assignee.
1 parent 645b8cc commit 6cf9536
Copy full SHA for 6cf9536

1 file changed

+12Lines changed: 12 additions & 0 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎.agents/skills/pull-requests/SKILL.md‎

Copy file name to clipboardExpand all lines: .agents/skills/pull-requests/SKILL.md
+12Lines changed: 12 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ Use the canonical docs for shared conventions and validation guidance:
2323
- Local validation commands and git hooks: `AGENTS.md` (Essential Commands and
2424
Git Hooks sections)
2525

26+
## Body Formatting
27+
28+
GitHub renders the PR description as Markdown and soft-wraps paragraphs to the
29+
viewport. Do not hard-wrap prose at 72 or 80 columns. Insert manual line
30+
breaks only where Markdown needs them: between paragraphs, around headings,
31+
lists, tables, code blocks, and blockquotes.
32+
33+
The commit message body is not the PR body. Commit messages are typically
34+
hard-wrapped; PR bodies are not. When deriving the PR body from a commit
35+
message, unwrap each paragraph into a single line before passing it to
36+
`gh pr create --body` or `--body-file`.
37+
2638
## Lifecycle Rules
2739

2840
1. **Check for an existing PR** before creating a new one:

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.