关于 prime-codebase
prime-codebase 是一项 Agent 技能,用于在开始工作前系统了解代码库。它可先读取 Jira 或 Confluence 参考资料,再梳理仓库、文档、架构和开发状态。
主要功能
- 01加载 Jira 和 Confluence 上下文
- 02检查跟踪文件与目录结构
- 03查阅项目文档和关键文件
- 04检查近期提交和 Git 状态
- 05生成结构化项目报告
适用场景
- 01开始处理代码库前建立背景
- 02依据 Jira 事项开展分析
- 03梳理架构与项目当前状态
MCP 相关
提供 Jira 或 Confluence 标识符时,工作流会调用 Atlassian MCP 工具获取相应事项和页面。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ coleam00/ skills --skill prime-codebase安装后在 Claude Code 中输入/prime-codebase确认已加载。
详细介绍
Prime:加载项目上下文
目标
通过分析代码库结构、文档和关键文件,全面了解代码库。如果提供了外部任务引用,请先加载,以便根据实际工作开展代码库分析。
流程
步骤 0:加载外部上下文
请在分析代码库之前运行此步骤。 此步骤接受可选参数:[jira-issue-keys] [confluence-page-ids]。
- Jira 键可以是单个键(
ACC-2),也可以是以逗号分隔的多个键(ACC-2,ACC-3)。 - Confluence 页面 ID 是数字页面 ID。
如果提供了 Jira 问题键:
- 调用
mcp__atlassian__getAccessibleAtlassianResources获取cloudId。 - 对每个 Jira 键,使用该
cloudId、问题键以及responseContentFormat: "markdown"调用mcp__atlassian__getJiraIssue。 - 将返回的问题摘要、描述和验收标准作为后续所有工作的任务上下文。
如果提供了 Confluence 页面 ID:
- 对每个页面 ID,使用
contentFormat: "markdown"调用mcp__atlassian__getConfluencePage(使用上一步获取的cloudId;如果尚未获取,则调用mcp__atlassian__getAccessibleAtlassianResources获取)。 - 将返回的页面内容作为辅助上下文(规格说明、设计文档、需求)。
如果未提供参数,则完全跳过此步骤,继续步骤 1。
继续之前,简要概述加载的外部上下文,以此明确后续工作的依据。
1. 分析项目结构
列出所有已跟踪的文件:
!git ls-files
显示目录结构:
在 Linux 上运行:tree -L 3 -I 'node_modules|__pycache__|.git|dist|build'
2. 阅读核心文档
- 阅读 CLAUDE.md 或类似的全局规则文件
- 阅读项目根目录和主要目录中的 README 文件
- 阅读所有架构文档
3. 确定关键文件
根据项目结构,确定并阅读:
- 主要入口文件(main.py、index.ts、app.py 等)
- 核心配置文件(pyproject.toml、package.json、tsconfig.json)
- 关键模型/架构定义
- 重要的服务或控制器文件
4. 了解当前状态
检查近期活动:
!git log -10 --oneline
检查当前分支和状态:
!git status
输出报告
提供简明摘要,涵盖以下内容:
外部任务上下文(如果已加载)
- Jira 问题:键、标题、单行目标、验收标准
- Confluence 页面:标题及其说明内容
项目概览
- 应用的用途和类型
- 主要技术和框架
- 当前版本/状态
架构
- 整体结构和组织方式
- 发现的关键架构模式
- 重要目录及其用途
技术栈
- 语言和版本
- 框架和主要库
- 构建工具和包管理器
- 测试框架
核心原则
- 观察到的代码风格和约定
- 文档规范
- 测试方法
当前状态
- 活跃分支
- 近期更改或开发重点
- 需要立即关注的观察事项或疑虑
请使用项目符号和清晰的标题,让摘要易于浏览。
评论
支持 Markdown