仓库建档
使用此工作流在实施之前快速了解一个代码库。
目标
生成一份简短、有据可查的仓库概况,包含风险点和后续步骤。
输出
.ai/PROJECT_PROFILE.md,使用templates/PROJECT_PROFILE.md模板。
规则
- 不要编辑产品代码。
- 不要重写架构。
- 优先依据观察到的代码模式而非假设。
- 保持概况简洁且可执行。
- “不适用”是某个主要领域的有效预期答案——对于一个没有后端的静态/作品集网站,它没有认证、数据库或AI逻辑轨道需要填写。应标记为“不适用”,而不是编造内容、猜测未来需求或留空/含糊不清。
步骤
- 检测框架、语言、包管理器和部署目标。
- 读取 package/lock/配置文件以及主要入口点。
- 识别可用的脚本:dev、typecheck、lint、test、build。
- 映射前端、后端、数据库、认证、AI、部署区域。
- 识别环境变量的使用模式。
- 捕捉代码中使用的当前架构模式。
- 列出明显缺失的生产环境基本要素和关键风险。
- 生成或更新
.ai/PROJECT_PROFILE.md。
最低证据
为每个发现引用具体的文件。示例类别:
- 脚本来源(
package.json、pyproject.toml等) - 部署来源(
vercel.json、Docker、CI 工作流) - 环境变量使用来源(
process.env、NEXT_PUBLIC_等) - 认证/数据边界(中间件、路由处理程序、策略文件)
完成检查
- 概况包含检测到的技术栈、脚本、主要领域、模式、风险点。
- 输出简短到足以在正常编码任务中发挥作用。