Prhub

#7116 [doc] chore: warn against hard-wrapping PR body markdown in pr skill

原始 PR 作者 zhangxin81 合并时间 2026-07-23 10:24 文件变更 1 提交数 1 评论 1 代码增减 +2 / -0

执行摘要

PR Skill 文档新增 Markdown 正文格式指导

PR 的 pr skill(.agent/skills/pr/SKILL.md)之前没有告知 Agent 如何格式化 PR 正文,导致 PR 正文有时被硬折行(固定列宽手动换行)。GitHub 将段落或列表项内的单个换行渲染为空格,这些手动折行在渲染后的 PR 中变成了意外的句中断裂。因此需要在 skill 中增加格式化指导。

建议仓库贡献者注意遵循此指导,确保 PR 正文在 GitHub 上正确渲染。该 PR 本身设计简单,无需精读源码。

讨论亮点

该 PR 有一条来自 gemini-code-assist[bot] 的评论,但内容是 Gemini Code Assist 消费者版本已停用的通知,与 PR 内容无关。无其他 review 评论。审核员 wuxibin89 批准了 PR,无额外讨论。

实现拆解

.agent/skills/pr/SKILL.md 的第二步“Compose PR Title and Body”末尾追加一段指导性文字,包含以下要点:

  1. 使用 GitHub-Flavored Markdown 而非固定宽度纯文本。
  2. 每个段落和列表项保持一个逻辑行,块之间用空行分隔。
  3. 不要硬折行运行文本——GitHub 将段落内的单个换行渲染为空格,手动折行会导致渲染后意外断句。
  4. 指出两种易忽略的情况:
    • 折行后下一行以 #<number> 开头(如 #7060)会在源码中读作标题,容易被拆开。
    • 缩进的列表项续行应保持在同一逻辑行内。
  5. 让编辑器软换行,仅在新段落、新列表项、新表格行或围栏代码块时插入新行。
  6. 提交前重读正文,确认没有段落或列表项被跨行拆分。
文件 模块 状态 重要度
.agent/skills/pr/SKILL.md 技能文档 modified 1.54

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

无技术风险。该变更为纯文档修改,不影响任何代码路径、配置、测试或部署行为。

影响范围极小,仅作用于 pr skill 的指导文本。后续 Agent 在创建或更新 PR 时将按照新的格式指导撰写正文,从而提升 veRL 仓库 PR 正文的 Markdown 渲染一致性,减少因硬折行导致的格式化问题。

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论