用途
repo-research-analyst 是一个面向代码仓库的调研分析技能,核心目标是帮助使用者快速、系统地理解一个代码库的组织方式、文档结构、项目约定与实现模式。它适合在加入新代码库、需要对齐项目规范或准备贡献代码时使用。
主要能力
该技能围绕以下几个方向展开调研:
- 架构与结构分析:检查关键文档文件(如 ARCHITECTURE.md、README.md、CONTRIBUTING.md、CLAUDE.md),梳理仓库的组织结构,识别架构模式与设计决策,记录项目特有的约定或标准。
- GitHub Issue 模式分析:查看已有 Issue 以识别格式模式,记录标签使用约定与分类方式,总结常见 Issue 结构与必需信息,识别自动化或机器人交互。
- 文档与指南审查:定位并分析所有贡献指南,检查 Issue/PR 提交要求,记录编码标准或风格指南,以及测试要求与审查流程。
- 模板发现:在 .github/ISSUE_TEMPLATE/ 中查找 Issue 模板,检查 Pull Request 模板,记录其他模板文件(如 RFC 模板),并分析模板结构与必填字段。
- 代码库模式搜索:在可用时使用 ast-grep 进行语法感知的模式匹配,否则回退到 rg 进行文本搜索,识别常见实现模式,记录命名约定与代码组织方式。
使用方式
该技能采用一套系统化的调研方法:
- 从高层文档入手,先理解项目背景。
- 根据发现逐步深入到具体领域。
- 在不同来源之间交叉验证发现。
- 优先采用官方文档,而非推断出的模式。
- 记录任何不一致或缺乏文档的部分。
在搜索策略上,它建议使用内置工具进行高效检索:Grep 工具用于文本/代码模式搜索(底层使用 ripgrep,支持正则);Glob 工具用于按模式发现文件(如 /*.md、/CLAUDE.md);Read 工具用于读取已定位文件的内容。对于基于 AST 的代码模式,可使用 ast-grep --lang ruby -p 'pattern' 或 ast-grep --lang typescript -p 'pattern'。同时建议检查常见文件名的多种变体。
输出格式
调研结果按以下结构组织:
- Repository Research Summary
- Architecture & Structure:项目组织、重要架构决策、技术栈与依赖。
- Issue Conventions:格式模式、标签分类与用法、常见 Issue 类型与结构。
- Documentation Insights:贡献指南摘要、编码标准与实践、测试与审查要求。
- Templates Found:模板文件清单及用途、必填字段与格式、使用说明。
- Implementation Patterns:常见代码模式、命名约定、项目特有实践。
- Recommendations:如何最好地对齐项目约定、需要澄清的领域、进一步深入调研的后续步骤。
适用场景
- 新加入某个代码库,需要快速上手。
- 准备向开源项目提交 Issue 或 Pull Request,需要了解格式与要求。
- 需要梳理项目的架构决策、编码规范与测试流程。
- 希望识别项目中的实现模式与命名约定,以便写出风格一致的代码。
限制与注意事项
- 该技能强调尊重在仓库中发现的 CLAUDE.md 或项目特定指令。
- 需要同时关注明确规则与隐含惯例。
- 解读模式时应考虑项目的成熟度与规模。
- 需注意文档中提到的任何工具或自动化。
- 调研应全面但聚焦,优先产出可执行的洞察。
- 质量保证方面:通过多个来源验证发现,区分官方指南与观察到的模式,注意文档的时效性(检查最后更新日期),标记任何矛盾或过时信息,并提供具体文件路径与示例来支撑发现。
- 关于收费、价格、平台支持等具体信息,资料中暂未提供。