Skip to content

docs(pr-template): 完善手动 PR 模板与 AI 使用声明 - #15

Merged
axiomoth merged 1 commit into
mainfrom
docs/pr-ready-template-20261008
Oct 8, 2026
Merged

axiomoth merged 1 commit into
mainfrom
docs/pr-ready-template-20261008

Conversation

@splrad-steward

@splrad-steward splrad-steward Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

摘要

重写 .github/pull_request_template.md,新增摘要、变更原因、主要改动、关联事项、验证结果、影响分析、发布迁移、回退方式及 AI 使用声明等结构化栏目。

主要改动

  • 顶部新增创建 PR 前删除提示段的说明
  • 补充通过 fork 贡献时需自行创建 PR 的说明
  • 新增摘要栏目,要求说明修改内容、预期效果及变更类型
  • 新增变更原因栏目,要求说明问题场景或需求背景
  • 新增主要改动、关联事项、验证结果栏目
  • 新增影响分析与发布迁移栏目,列出需说明的具体事项
  • 新增回退方式栏目,要求说明恢复步骤和限制
  • 新增 AI 使用声明三选项及补充材料栏目

影响分析

  • 手动创建 PR 的贡献者需按新结构填写更多栏目
  • PR 需明确声明是否使用 AI 编程助手及审查情况

贡献者:@axiomoth

Signed-off-by: Axiomoth <alearner@splrad.com>
Copilot AI balanced review requested due to automatic review settings October 8, 2026 09:36
@splrad-steward splrad-steward Bot added area:automation 修改仓库自动化。 chore 其他仓库维护、元数据或一般配置。 labels Oct 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

模板遗漏关键流程约束,且 AI 声明缺少单选指引。

1 open finding
What changed in this PR

完善组织默认 PR 模板,规范手动创建 PR 时的信息填写与 AI 使用声明。

Changes:

  • 新增结构化的变更、验证、影响及回退栏目。
  • 补充 Steward 与 fork 提交流程说明。
  • 新增 AI 使用声明。
File Description
.github/​pull_request_template.md 重构组织默认 PR 模板。

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Comment thread .github/pull_request_template.md
@axiomoth
axiomoth marked this pull request as ready for review October 8, 2026 09:49
@axiomoth
axiomoth requested a review from a team October 8, 2026 09:49
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T09:53:16.645440Z 93d19b0 Draft marked ready
🔒 Security Review ✅ Completed 2026-10-08T09:53:25.583068Z 93d19b0 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@axiomoth
axiomoth merged commit ddb243d into main Oct 8, 2026
5 checks passed
@axiomoth
axiomoth deleted the docs/pr-ready-template-20261008 branch October 8, 2026 09:52

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 93d19b0b41

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


手动创建 PR 时,请填写下列内容并删除填写提示;不适用的栏目填写“无”。

<!-- workflow:managed-pr:start -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 将人工填写内容移出 Steward 受管区

在 fork 提交或机器人故障补建的 PR 后续被 Steward 更新时,这些位于 workflow:managed-pr 标记内的摘要、验证结果、风险和 AI 声明都会被重新生成的正文覆盖;README.md:20 已明确说明 Steward 会重新生成正文,而本次又删除了原先要求把需保留信息写入评论的提示。请将需长期保留的人工内容放到受管区外,或恢复明确警告并引导贡献者把这些信息写入不会被覆盖的位置。

AGENTS.md reference: AGENTS.md:L13-L15

Useful? React with 👍 / 👎.

Comment on lines +66 to +68
- 本次贡献未使用 AI 编程助手。
- 本次贡献使用了 AI 编程助手,人类进行了审查。
- 本次贡献完全由 AI 编程助手代理生成,没有人类参与。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 让 AI 声明成为明确的单选操作

手动创建 PR 时,这三项会作为普通列表同时保留并形成互相矛盾的声明,因为模板没有要求只保留其中一项,也没有提供可选择的控件;GitHub 的可点击任务项需要使用 - [ ] 语法。请明确要求删除其余两项,或改为任务列表并注明只能勾选一项,避免未编辑模板的 PR 同时声称未使用、经人工审查和无人参与。

AGENTS.md reference: AGENTS.md:L21-L23

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:automation 修改仓库自动化。 chore 其他仓库维护、元数据或一般配置。

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants