mcpField
G
github-codebase-briefing

github-codebase-briefing

github.com/google-labs-code开发1.8k77 次安装4 周前更新
代码仓库

关于 github-codebase-briefing

供 Agent 深入阅读代码库并分析 GitHub 未关闭议题与拉取请求的技能,结合架构背景提炼优先事项和重复模式。

主要功能

  1. 01审阅仓库架构
  2. 02分析未关闭议题与 PR
  3. 03追踪近期变更
  4. 04标记安全与合并就绪状态
  5. 05归纳跨条目模式

适用场景

  1. 01准备每日仓库状态简报
  2. 02依据现有代码模式检查 PR
  3. 03发现议题集群和常变模块

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/google-labs-code/stitch-sdk --skill github-codebase-briefing

安装后在 Claude Code 中输入/github-codebase-briefing确认已加载。

详细介绍

GitHub 代码库简报

此技能会对代码库进行“深度阅读”。它不会停留在表面罗列,而是先了解项目架构,再结合这一背景评估待办事项。

前置条件

  • **工具:**Agent 必须能够使用 gh CLI。
  • **身份验证:**用户必须已完成身份验证(gh auth status)。

说明

步骤 1:建立整体认知

在查看任务之前,先了解环境。按顺序运行以下命令:

  1. 元数据:gh repo view <owner/repo> --json name,description,stargazerCount,forkCount
  2. 结构:gh api repos/<owner/repo>/contents/
  3. **项目身份:**阅读项目清单(例如 package.json、go.mod、pyproject.toml)和 README.md。
  4. **入口点:**阅读主要入口文件(例如 index.ts、main.go),以确定公共 API 的范围。
步骤 2:获取状态与变化

获取当前事项和近期变化:

  1. Issues:gh issue list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,comments
  2. PR:gh pr list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,additions,deletions,changedFiles,headRefName
  3. 24 小时变化:gh issue list --state closed --since 24h 和 gh pr list --state merged --since 24h。
步骤 3:深度分析逻辑

对于每个 Issue 和 PR,不要只概述文本,还要进行逻辑核查:

  • **Issues:**使用 gh api repos/<owner/repo>/contents/<path> 检查报告中提及的代码。
  • **PR:**使用 gh pr diff <number> 审查实际实现。评估代码是否遵循步骤 1 中发现的模式。
  • 标记:
    • 🚨 **安全:**扫描凭据、身份验证绕过或注入相关关键词。
    • 🤝 **外部贡献:**优先处理来自非维护者的 PR。
    • ✅ **可合并:**使用 gh pr view <number> --json mergeable,statusCheckRollup 确认是否可合并。
步骤 4:综合归纳模式

将事项归纳为高层见解:

  • **漏洞群组:**识别是否有 3 个或更多 Issue 在特定模块中有共同根因。
  • **热点模块:**标记出现在多个待处理事项中的文件。
  • **客户端模式:**按使用者对 Issue 进行分组(例如,“VS Code 用户报告了 X”)。

输出模板

# {REPO_NAME} 每日简报 — {DATE}

概览:{N} 个 Issues(较昨日 {+X})| {M} 个 PR(较昨日 {+Y})

⚡ 今日建议操作
  1. [优先级] #{Num}:{单行原因}
  2. [优先级] #{Num}:{单行原因}

📂 未解决 Issues 深度分析
[标记] #{Num} — {标题}
  • **背景:**用通俗易懂的语言解释代码库中的“原因”和“位置”。
  • 关键证据:> {关键用户文本的引用}
  • 解决路径:{快速修复/设计决策/受阻}
🔀 Pull Request 分析
[标记] #{Num} — {标题}
  • **影响:**变更文件的摘要及其与架构的契合度。
  • **质量备注:**如实评估实现情况和 CI 状态。
🔍 模式与健康状况
  • 热点模块:{list/of/files}
  • **发布节奏:**上次发布距今 {days} 天。

评论

支持 Markdown