SuperAPI AI 工具集

add-best-practice

通用与其它

查看项目

更新于 10-15 20:08

技能介绍

用途:在 brave-core(src/brave)仓库中,把一条新的最佳实践规则加入正确的 best-practices 文档,避免重复、分配稳定 ID,并保持与现有条目一致的格式。

主要能力与流程:

  1. 确认工作目录,文档位于 ./docs/best-practices/,索引为 ./docs/best_practices.md。
  2. 解析参数理解规则内容、原因与所属分类;若参数是 GitHub PR 评论 URL,用 gh api 获取评论、diff 与源码上下文,强调不能只看评论文字。
  3. 在全部文档中检索是否已有相同或近似规则,若重复则提示已由某规则覆盖并停止。
  4. 用 python3 ./.claude/skills/review/discover-bp-docs.py ./docs/best-practices/ --list-categories 动态发现文档与分类,选择目标文档;若不属于任何现有文档且可能衍生多条规则,则新建分类文档,并在 script/manage-bp-ids.py 的 DOC_PREFIXES 与索引中登记。
  5. 按固定格式起草条目(含 ✅/❌ 代码示例、加粗原则、--- 分隔),先经 review 子代理校验,再交用户确认。
  6. 追加到文档末尾,手动取该前缀最大 ID 加一替换 PLACEHOLDER,不用 --assign。
  7. 运行 python3 ./script/manage-bp-ids.py --validate 校验。
  8. 提交前必须 git add 新文档后执行 pnpm run format,否则 CI 会失败。
  9. 以单个原子提交提交,并询问是否创建分支与 PR。

限制与注意:不得复用旧 ID、不得填补 ID 空缺、不得手动挑选 ID;提交与 PR 中不得包含 Claude Code 归属信息;条目应简洁可扫读。