spec-coding-skills/CLAUDE.md.template
zfc 398d0348f8 feat: Add CLAUDE.md template and changelog skill
Add reusable CLAUDE.md.template with placeholder-based structure for new projects,
and add /changelog skill for automated release workflow.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-26 14:10:17 +08:00

107 lines
2.6 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## 最重要的事情
1. **TDD 先行** - fix/feat 必须先写失败测试,红黄绿循环
2. **原子提交** - 每个 commit 只做一件事,可独立回滚
3. **文档驱动** - feat 改动关联 doc/ 下文档多输出表格、流程图、ASCII 原型图
4. **知识沉淀** - 有价值的迭代沉淀到 CLAUDE.md拿捏不准主动问我
5. **利用现有工具** - 不重复造轮子,会开车 > 会修车
6. **任务结束后追加** - 主人,用不用我沉淀 or git 提交?
## 项目概述
**{{项目名称}}** — {{一句话描述}}
**产品目标**
- {{目标1}}
- {{目标2}}
- {{目标3}}
## 技术栈
| 层级 | 技术 | 说明 |
|------|------|------|
| 前端 | {{前端技术}} | {{说明}} |
| 后端 | {{后端技术}} | {{说明}} |
| 数据库 | {{数据库}} | {{说明}} |
| 缓存 | {{缓存方案,如无可删除此行}} | {{说明}} |
| AI 服务 | {{AI 服务,如无可删除此行}} | {{说明}} |
| 部署 | {{部署方案}} | {{说明}} |
## 项目结构
```
{{项目名称}}/
├── {{目录1}}/ # {{说明}}
│ ├── {{子目录}}/ # {{说明}}
│ └── {{子目录}}/ # {{说明}}
├── doc/ # 项目文档
│ ├── PRD.md
│ ├── DevelopmentPlan.md
│ └── tasks.md
└── {{其他文件}} # {{说明}}
```
## 常用命令
### 开发
```bash
{{开发启动命令}}
```
### 构建
```bash
{{构建命令}}
```
### 测试
```bash
{{测试命令}}
```
### 部署
```bash
{{部署命令}}
```
## 开发约定
- **包管理器**: 使用 {{包管理器}}(不是 {{其他包管理器}}
- **TDD 流程**: 先写测试再实现,核心业务逻辑覆盖率 100%
- **日志规范**: 使用日志管理器,避免 console.log
- **知识沉淀**: 将有价值的对话迭代沉淀到文档中,包括:
- 重要技术决策和架构演进 → 更新 CLAUDE.md 相关章节
- 新功能实现方案 → 更新组件职责、数据流等章节
- 踩坑经验和解决方案 → 添加到踩坑经验章节
- API 使用技巧和注意事项 → 更新相关技术栈说明
{{在此添加项目特定的开发约定}}
## 交互准则
- 任务彻底结束后,追加一句:**主人,用不用我沉淀 or git 提交?**
## 踩坑经验
<!-- 格式示例:
### {{问题简述}}
**问题现象**{{描述现象}}
**根因**{{分析根因}}
**解决方案**{{解决方案}}
**注意事项**{{补充说明}}
-->