From 9e6d7de0fa804c6bb6fd41ea19f4e749909c3eb2 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Tue, 7 Jul 2026 22:16:07 +0800 Subject: [PATCH] docs(agents): forbid hard-wrapping prose in PR/issue bodies (#4374) GitHub renders single newlines inside a paragraph as line breaks, so hard-wrapped PR/issue/discussion prose shows up with ugly mid-sentence breaks. Add a rule under Git and PR Baseline to keep each paragraph on one line. --- AGENTS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 895a4b5fa..dd9b150a9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -108,6 +108,10 @@ Do not open a PR with code changes when the required checks fail. - Include verification commands in the PR description. - When using `gh pr create`/`gh pr edit`, use `--body-file` instead of inline `--body` for multiline markdown. - Do not include the literal sequence `\n` in any GitHub issue, pull request, or discussion comment. +- Do not hard-wrap prose in PR/issue/discussion bodies; write each paragraph as a + single line and let it reflow. GitHub renders single newlines inside a paragraph + as line breaks, so mid-sentence wrapping shows up as ugly breaks. Only break lines + for list items, code blocks, and deliberate separators. - After fixing code review comments or CI findings, always mark corresponding review comments/threads as resolved before returning to the user. - In handling review comments, confirm the underlying issue before changing code.