SuperAPI AI 工具集

copilot-review-init

编程与开发

查看项目

更新于 10-16 06:16

技能介绍

用途:为特定仓库生成一整套 GitHub Copilot 代码审查指令文件。Copilot 会读取 PR 仓库中的指令文件来指导分析,本技能据此生成仓库级标准与按文件类型限定的微文件。

产出内容:.github/copilot-instructions.md 为仓库级通用审查标准;.github/instructions/*.instructions.md 为按 applyTo frontmatter 限定作用范围的微文件。采用微文件架构的原因:每个文件控制在 Copilot 的 4000 字符处理窗口内(超出部分会被静默忽略);语言专属规则不会污染无关文件;各团队可独立维护;新增关注点即新增文件。配置良好的仓库通常产出 5–12 个指令文件。

工作流程:第一阶段探索仓库,识别结构(单仓或多服务、目录布局、需忽略的构建产物)、技术栈(扫描 package.json、tsconfig.json、requirements.txt、pyproject.toml、Cargo.toml、tauri.conf.json、go.mod、*.csproj、docker-compose.yml、.github/workflows/ 等)、已有指令文件(含 .cursorrules、.windsurfrules、CLAUDE.md、AGENTS.md、REVIEW.md、CONTRIBUTING.md)、已有 lint/格式化工具(ESLint、Prettier、Biome、Black、Ruff、isort、rustfmt、clippy、golangci-lint,已强制项不再写规则)以及痛点(近期 PR、issue、git 历史、TODO/FIXME/HACK)。第二阶段规划架构,按检测到的语言、框架与领域决定文件,单仓可为不同包建独立文件,每个文件目标 2500–3500 字符。第三阶段编写,规则需具体、可度量、可操作、语义化;按安全、架构、错误处理、代码质量、性能、测试的顺序排列;可含 before/after 示例,使用仓库真实模式。第四阶段验证,检查 frontmatter、字符数、glob 语法、规则重叠、命名等。第五阶段按文件树、完整内容、生成理由输出。

关键注意事项:.instructions.md 必须位于 .github/instructions/,copilot-instructions.md 必须位于 .github/ 根目录;applyTo 是单个 glob 字符串而非数组;Copilot 无法访问外部链接;指令不能改变评论格式、PR 概览或合并行为;行为非确定性属正常;缺少 applyTo 的文件不生效。建议先从 10–20 条聚焦规则起步,再依实际 PR 结果迭代。参考文件包括 references/instruction-spec.md、anti-patterns.md、scenarios.md、micro-library.md。

限制:资料未提供收费、价格、平台支持范围或确切效果等信息。