Skip to content

📄 明确代理创建 PR 的描述规范#1601

Merged
CodFrm merged 2 commits into
scriptscat:mainfrom
cyfung1031:pr/agents-improved-pr
Jul 17, 2026
Merged

📄 明确代理创建 PR 的描述规范#1601
CodFrm merged 2 commits into
scriptscat:mainfrom
cyfung1031:pr/agents-improved-pr

Conversation

@cyfung1031

@cyfung1031 cyfung1031 commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Checklist / 检查清单

  • Changes tested / 已完成检查
  • Code reviewed by human / 代码通过人工检查

背景

代理创建 PR 时需要参考近期 PR 的详细说明结构,但人工使用的 PR 模板应继续保持轻量;详细指导不应增加到常驻加载的 AGENTS.md 中。

本次改动

  • 将详细 PR 描述规范移至 docs/pull-request.md
  • AGENTS.md 压缩为指向该文档的短引用。
  • docs/develop.mddocs/README.mddocs/DOC-MAINTENANCE.md 中补充文档入口与职责。
  • 明确代理应保留人工 PR 模板,不得虚报人工审核、测试、截图或录屏。
  • 保持 .github/pull_request_template.md 不变。

验证

  • git diff --check:通过
  • 核心文档相对链接检查:通过
  • 确认 .github/pull_request_template.md 未被修改
  • 提交时项目钩子通过;无 JS/TS 文件需要额外检查

@cyfung1031
cyfung1031 marked this pull request as ready for review July 17, 2026 11:49
@CodFrm

CodFrm commented Jul 17, 2026

Copy link
Copy Markdown
Member

应该引用文件吧,不需要在agents.md里面写

@cyfung1031

Copy link
Copy Markdown
Collaborator Author

应该引用文件吧,不需要在agents.md里面写

fixed in f548caf

@CodFrm

CodFrm commented Jul 17, 2026

Copy link
Copy Markdown
Member

应该引用文件吧,不需要在agents.md里面写

fixed in f548caf

原来也有一个.github/ 的模板,为什么不直接修改、引用这个呢?

@cyfung1031

cyfung1031 commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator Author

应该引用文件吧,不需要在agents.md里面写

fixed in f548caf

原来也有一个.github/ 的模板,为什么不直接修改、引用这个呢?

人类写的PR 和 Agents 写的PR 不一样吧
Agents写的话要求它们要清楚说明
#1566 就是例子

人类写的话不能规限这么多吧

而且你有看到 这里的写法是,这个格式不是完全硬性规定
PR有很多种类 (文档修正,翻译,bug 修补,新功能 ...)
太详细的话有一些是不适用
因此 agent 也要灵活按实际PR内容,不是硬性跟随规定

所以它的寫法是

Start from the human-facing template, preserve its checklist, and expand the description only when the change needs more context. 

@CodFrm
CodFrm merged commit 7dc4a92 into scriptscat:main Jul 17, 2026
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants