SuperAPI AI 工具集

conventional-comments

测试与质量

查看项目

更新于 10-16 01:16

技能介绍

用途:这是一个帮助你按 Conventional Comments 标准撰写评审评论的技能,适用于代码审查、PR 反馈、RFC 评审和同行评审等场景,让评论更容易理解和检索。

评论格式:<label> [decorations]: <subject>,下方可选 [discussion]。label 必填,表示评论类型;subject 必填,是评论主旨;decorations 可选,放在标签后的括号内,用逗号分隔;discussion 可选,用于补充背景、理由和后续步骤。

主要标签:praise 指出优点,每次评审至少留一条且必须真诚;nitpick 偏好类的小请求,默认非阻塞;suggestion 提出改进,需说明改什么和为什么;issue 指出具体问题,尽量搭配建议;todo 小而必要的小改动;question 表示你不确定的潜在顾虑;thought 评审中产生的想法,非阻塞;chore 接受前必须完成的任务;note 始终非阻塞,提醒读者注意。另有可选表达型标签:typo、polish、quibble。

装饰项:括号内可加 (non-blocking) 不应阻止合并、(blocking) 必须解决、(if-minor) 仅在修复简单时处理,也可添加自定义装饰如 security、ux、test、performance,但要保持精简。

格式要求:评论输出必须是合法的 GitHub 风格 Markdown,假定会被粘贴到 PR 评论中。仅在指向其他文件或行时写明路径或行号,否则由 GitHub 评审界面定位。行内代码用单反引号包裹,多行代码用带语言标签的围栏代码块;建议替换时同时展示当前代码和提议代码。

沟通建议:保持好奇,多用提问而非下结论;用“我们”代替“你”;留下可执行的评论,明确如何解决;合并相似评论;耐心指导。资料未提供安装命令或平台限制等更多信息。