SuperAPI AI 工具集

refining

通用与其它

查看项目

更新于 10-16 00:00

技能介绍

Refining 是一个面向代码评审的技能,目标是让代码变更更容易被人类评审者理解和审查。其核心理念是:评审者注意力有限,因此应关注变更的内聚性而非单纯的行数。

主要能力包括三种模式:Commit(校验暂存区变更,评估内聚性、规模与噪声,按 Conventional Commits 格式生成提交信息并提交,除非明确要求否则不推送);Review(评估 PR/MR 或分支对比,按严重程度分级报告,聚焦自动化工具难以发现的问题);Create PR/MR(生成面向评审者的标题、描述与上下文,使用 gh pr create 或 glab mr create 创建)。

使用方式上,Commit 模式通过 git diff --cached --stat 检查暂存变更,再执行 git commit -m "type(scope): description";Create PR/MR 模式通过 git log --oneline main..HEAD 收集变更。描述结构包含 Summary、Changes、Testing、Reviewer Notes 四部分。

适用场景为提交前整理变更、评审他人 PR/MR、创建便于评审的合并请求。限制方面:行数阈值仅为启发式参考,需结合变更复杂度判断;噪声检测(如 console.log、TODO、注释代码)仅提示用户,由用户决定是否保留;遇到不确定情况应询问用户而非自行决定。参考资料包括 reviewability.md、description-guide.md、review-strategies.md、review-checklist.md、impact-analysis.md,按需加载。具体平台支持与安装方式暂未提供。