Repository navigation
docs(pr-template): 完善手动 PR 模板与 AI 使用声明 #15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,74 @@ | ||
| **创建 PR 前,请删除本提示段。** | ||
|
|
||
| 向本仓库推送工作分支后,请等待 SPLRAD Steward 自动创建或更新 PR;确认机器人故障且没有对应 PR 时,再手动补建。 | ||
|
|
||
| 通过 fork 贡献时,请自行创建 PR。 | ||
|
|
||
| 手动创建 PR 时,请填写下列内容并删除填写提示;不适用的栏目填写“无”。 | ||
|
|
||
| <!-- workflow:managed-pr:start --> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 在 fork 提交或机器人故障补建的 PR 后续被 Steward 更新时,这些位于 AGENTS.md reference: AGENTS.md:L13-L15 Useful? React with 👍 / 👎. |
||
| ## PR 创建说明 | ||
|
|
||
| **推送到本仓库的工作分支后,PR 由 SPLRAD Steward 自动创建或更新,无需手动操作。** | ||
| ## 摘要 | ||
|
|
||
| 用一两句话说明本次修改及预期效果。 | ||
|
|
||
| 变更类型:缺陷修复 / 新功能 / 重构 / 性能优化 / 文档 / 测试 / 构建与依赖 / 其他。 | ||
|
|
||
| ## 变更原因 | ||
|
|
||
| 说明要解决的问题、发生场景或需求背景。 | ||
|
|
||
| 修复缺陷时,说明原有行为、预期行为及复现方式;较大的设计调整请补充方案选择和主要取舍。 | ||
|
|
||
| ## 主要改动 | ||
|
|
||
| - | ||
| - | ||
|
|
||
| ## 关联事项 | ||
|
|
||
| 填写相关 Issue、讨论或其他 PR 的编号或链接,并说明关系。 | ||
|
|
||
| - **完整解决:** 使用 `Closes #议题编号`,表示合并到默认分支后关闭该议题。 | ||
| - **部分解决或仅相关:** 使用普通编号或链接,说明完成范围及剩余问题。 | ||
|
|
||
| ## 验证结果 | ||
|
|
||
| - **验证环境:** 相关系统、运行时及依赖版本。 | ||
| - **验证步骤:** 执行的命令、测试或手动操作,便于审查者复现。 | ||
| - **实际结果:** 通过、失败或发现的问题,可附检查和日志链接。 | ||
| - **未验证事项:** 未覆盖的场景及原因。 | ||
|
|
||
| ## 影响分析 | ||
|
|
||
| 说明适用的影响: | ||
|
|
||
| - 受影响的功能、模块及使用者。 | ||
| - 接口、配置、数据格式或行为的兼容性变化。 | ||
| - 新增或调整的依赖、权限、外部服务及费用。 | ||
| - 对安全、隐私、性能或资源占用的影响。 | ||
| - 已知风险、限制和暂未解决的问题。 | ||
|
|
||
| ## 发布与迁移 | ||
|
|
||
| 说明适用的发布要求: | ||
|
|
||
| - 面向使用者的变化,以及文档或发布说明的更新位置。 | ||
| - 升级需要的配置、数据迁移、操作顺序或停机安排。 | ||
| - 需要先完成的其他 PR、版本或外部变更。 | ||
|
|
||
| ## 回退方式 | ||
|
|
||
| 说明恢复步骤、备份要求,以及数据或其他不可逆变化带来的恢复限制。 | ||
|
|
||
| ## AI 使用声明 | ||
|
|
||
| - 本次贡献未使用 AI 编程助手。 | ||
| - 本次贡献使用了 AI 编程助手,人类进行了审查。 | ||
| - 本次贡献完全由 AI 编程助手代理生成,没有人类参与。 | ||
|
Comment on lines
+66
to
+68
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 手动创建 PR 时,这三项会作为普通列表同时保留并形成互相矛盾的声明,因为模板没有要求只保留其中一项,也没有提供可选择的控件;GitHub 的可点击任务项需要使用 AGENTS.md reference: AGENTS.md:L21-L23 Useful? React with 👍 / 👎. |
||
|
|
||
| - **机器人故障时:** 确认该分支尚无对应 PR 后,可手动补建。 | ||
| - **通过 fork 贡献时:** 请从自己的 fork 向本仓库发起 PR。 | ||
| ## 补充材料 | ||
|
|
||
| **AI 编码助手:** 向本仓库推送后,应检查对应 PR 和自动化状态,默认等待机器人处理。故障补建或从 fork 发起 PR,均须有用户明确授权;提交或推送授权不包含创建 PR。 | ||
| 填写其他需要审查者了解的背景、待讨论问题,以及必要的截图、日志或设计材料链接。 | ||
|
|
||
| 手动创建 PR 时,请填写标题和变更说明,并保留受管注释标记。Steward 后续更新会重新生成标题和正文;需要保留的补充信息请写在 PR 评论中。 | ||
| <!-- workflow:managed-pr:end --> | ||
Uh oh!
There was an error while loading. Please reload this page.