[Feature]: 添加CLAUDE.md

[Disdjj]

问题描述

期望的解决方案

替代方案

附加信息

No response

[github-actions]

🎯 技术评估报告

📋 需求摘要

为项目添加 CLAUDE.md 文件,提供项目上下文和使用说明,帮助 Claude Code 更好地理解和处理项目自动化任务

关键功能点:

1. 为 Claude Code 提供项目架构和目的的上下文说明
2. 说明项目的技术栈和关键组件
3. 描述自动化工作流的触发规则和执行逻辑
4. 提供 Skills 的使用指南和最佳实践
5. 包含开发者贡献指南和注意事项

🔧 推荐方案

方案名称: 创建结构化的 CLAUDE.md 文档

技术架构:
在项目根目录创建 CLAUDE.md 文件,采用以下结构:

CLAUDE.md
├── 项目概述
│   ├── 项目目的
│   ├── 核心功能
│   └── 技术栈
├── 项目架构
│   ├── 目录结构说明
│   ├── 关键模块
│   └── 依赖关系
├── 自动化工作流
│   ├── Issue 触发规则
│   ├── PR 审查流程
│   └── Skill 调用机制
├── Skills 使用指南
│   ├── issue-analyze
│   ├── feature-plan
│   └── pr-review
└── 开发指南
    ├── 如何添加新 Skill
    ├── 如何修改现有 Skill
    └── 测试和调试建议

实现要点:

• 采用清晰的 Markdown 层级结构
• 包含代码示例和配置说明
• 提供实际的工作流触发示例
• 说明每个 Skill 的输入输出格式
• 包含常见问题和解决方案

优势:

• 提升 Claude Code 对项目的理解准确度
• 减少自动化任务的错误率
• 为新的自动化功能提供参考文档
• 帮助开发者理解如何与 Claude Code 协作
• 提供 Skills 的使用规范和最佳实践

劣势:

• 需要持续维护以保持文档与代码同步
• 初次编写需要投入一定时间梳理项目结构

📊 实现规模

维度	评估
工作量级别	small
预估改动文件数	1
爆炸半径	isolated

需修改的模块:

• 无需修改现有模块

需新增的模块:

• CLAUDE.md - 项目上下文文档,位于根目录

⚠️ 风险评估

风险	级别	缓解措施
文档过时导致 Claude 理解偏差	低	在每次架构变更时同步更新文档
文档内容过于冗长影响可读性	低	采用清晰的层级结构,突出重点信息

📝 实现步骤

1. 创建 CLAUDE.md 文件框架,包含项目概述、目的和技术栈 - simple

   • 在根目录创建文件
   • 添加项目基本信息和技术栈说明

2. 添加项目结构说明,详细描述 .claude/skills 和 .github/workflows 的组织方式 - simple

   • 绘制目录结构树
   • 说明关键目录的作用

3. 编写工作流触发规则说明,解释 bug/enhancement 标签如何触发对应的 Skills - simple

   • 描述 Issue 触发机制
   • 说明 PR 审查流程

4. 添加 Skills 使用指南,说明每个 Skill 的功能和调用方式 - simple

   • 为每个 Skill 编写功能说明
   • 提供输入输出示例

5. 完善开发者贡献指南,包括如何添加新 Skill 和修改现有 Skill - simple

   • 提供 Skill 开发模板
   • 说明测试和部署流程

🧪 测试建议

单元测试:

• 无需单元测试,这是文档性质的变更

集成测试:

• 验证文档中的代码示例和配置是否正确
• 检查工作流触发规则描述是否与实际配置一致

E2E 测试:

• 创建测试 Issue 验证触发流程
• 检查 Claude Code 是否能正确理解 CLAUDE.md 中的指导

❓ 待澄清问题

1. CLAUDE.md 的详细程度如何把握?(建议:重点说明架构和工作流,避免过度细节)
2. 是否需要包含 Skill 的开发最佳实践和反模式示例?
3. 是否需要添加项目的长期规划和路线图?

---

🤖 由 Claude 自动生成

[Disdjj]

ok 就按照这个写吧

[Disdjj]

ok 写吧

[github-actions]

✅ 代码实现已完成

已成功创建 feat/issue-2 分支并推送到远程仓库。

改动文件

• CLAUDE.md - 新增项目上下文文档（706 行）

主要内容

1. 项目概述 - 项目目的、核心功能、技术栈
2. 项目架构 - 完整的目录结构和模块说明
3. 自动化工作流详解 - Issue/PR 触发规则和执行流程
4. Skills 使用指南 - 四个 Skill 的详细说明、输入输出格式和最佳实践
5. 开发指南 - 如何添加/修改 Skill，调试测试建议
6. 配置说明 - Secrets 配置、权限说明、注意事项
7. 工作流示例 - Bug 修复和功能需求的完整流程

创建 Pull Request

由于 GitHub Actions 权限限制，请手动创建 PR：

访问: main...feat/issue-2

文档亮点

• 结构化清晰，层级分明
• 包含大量代码示例和配置说明
• 提供实际的工作流触发示例
• 说明每个 Skill 的输入输出格式
• 包含开发者贡献指南和最佳实践
• 使用简体中文编写，易于理解

此文档将帮助 Claude Code 更准确地理解项目架构和目的，减少自动化任务的错误率。

请查看代码并创建 PR 进行审查。