SuperAPI AI 工具集

tidb-pr-metadata-guard

数据与分析

查看项目

更新于 10-16 08:05

技能介绍

用途:在创建或编辑 TiDB 拉取请求(PR)时,保持仓库要求的 PR 结构与元数据不被破坏,只修改允许变动的部分。

主要能力与用法:写 PR 标题和描述用英文;新 PR 从 .github/pull_request_template.md 开始,而不是从零编写正文,可用 gh pr create -T .github/pull_request_template.md 创建。标题格式为 pkg [, pkg2, pkg3]: what is changed 或 *: what is changed,其中 pkg 指 TiDB 模块区域而非字面 Go 包路径,例如 pkg/planner/core 通常对应 planner。编辑已有 PR 时只更新可变部分,如 Issue Number:、Problem Summary:、### What changed and how does it work? 下的内容、测试复选框状态与具体命令、release-note 块。不要重命名标题、重排清单或整体重写模板,须原样保留隐藏 HTML 注释,包括 Tests <!-- At least one of them must be included. --> 以及 No need to test 嵌套块及其注释。

流程与检查:优先基于文件编辑,将拟提交的正文写入本地 Markdown 文件,对照模板检查后再调用 gh;更新 PR 正文后重新读取 PR,确认机器人控制的标签是否如预期变化,例如 do-not-merge/needs-linked-issue、do-not-merge/needs-tests-checked。若标签仍异常,先将当前正文与模板做 diff。若需要新增关联 issue,先使用 tidb-issue-metadata-guard 创建或识别 issue,再只修补 PR 正文中的 Issue Number: 行。检查要点:正文保留 Issue Number: 行并可使用 close #<id>、ref #<id> 等完整关键字语法;标题使用 planner、executor 或 * 等模块化范围而非原始 Go 包路径;Tests 行保留模板 HTML 注释原文;至少勾选一个测试复选框,或勾选 No need to test 并写明原因。

适用场景:面向 pingcap/tidb 仓库的 PR 元数据维护。限制:仅处理 PR 元数据与模板结构,不替代代码质量检查;具体安装方式与其他能力暂未提供。