SuperAPI AI 工具集

pr-naming-convention

编程与开发

查看项目

更新于 10-15 19:58

技能介绍

用途:该技能用于校验拉取请求(PR)标题和分支名是否符合公司统一的命名规范,帮助在代码评审前发现格式问题。

主要能力:校验 PR 标题与分支名;在用户创建新 PR 时给出正确标题格式;解答团队 PR 或分支命名规则;修正格式错误的标题或分支名。

规范摘要:PR 标题格式为 [TEAM-<number>] <type>: <description>,类型包括 feat、fix、docs、refactor、test、chore;描述最多 72 字符,首字母小写,结尾不加句号。分支名格式为 <team>/<ticket>-<description>,例如 platform/TEAM-42-add-auth,描述使用 kebab-case(小写加连字符)。完整规范与边界情况见技能目录中的 references/naming-rules.md。

使用方式:调用技能目录中的校验脚本 scripts/check_pr.py,该脚本仅使用纯正则匹配,不调用 shell 命令、不使用 eval,除 Python 标准库外无外部依赖。校验标题:python <skill-path>/scripts/check_pr.py title "[TEAM-42] feat: add user authentication";校验分支:python <skill-path>/scripts/check_pr.py branch "platform/TEAM-42-add-auth"。脚本向标准输出打印 JSON 对象,成功时包含 valid、input、type 字段;失败时额外包含 errors 数组说明原因。

修正建议:校验失败时不仅报告错误,还应给出修正版本。例如输入 "added login feature for TEAM-42" 可建议改为 "[TEAM-42] feat: add login feature";分支 "feature/login-page" 可建议改为 "platform/TEAM-42-add-login-page",若缺少团队名和工单号需向用户询问。

适用场景:提交 PR 前检查标题、创建分支、统一团队命名规范、修复已有标题或分支名。

限制:仅做格式校验,不涉及代码内容或业务逻辑;具体团队名与工单号需用户提供;资料未提供其他平台集成或自动化触发方式。