Files
photography/scripts/README.md
xujiang 9e381c783d
All checks were successful
Deploy Frontend / deploy (push) Successful in 2m38s
feat: 重构项目为模块化结构,拆分 CLAUDE.md 文档
## 📁 模块化重构

### 新增模块 CLAUDE.md
- `frontend/CLAUDE.md` - 前端开发指导 (Next.js, React, TypeScript)
- `docs/deployment/CLAUDE.md` - 部署配置指导 (Caddy, 服务器配置)
- `.gitea/workflows/CLAUDE.md` - CI/CD 流程指导 (Gitea Actions)

### 根目录 CLAUDE.md 优化
- 重构为项目概览和模块导航
- 提供模块选择指导
- 减少单个文件的上下文长度

### 自动化机制
- 创建 `scripts/update-claude-docs.sh` 自动更新脚本
- 集成到 pre-commit hooks 中
- 文件变更时自动更新对应模块的 CLAUDE.md

## 🎯 优化效果

### 上下文优化
- 每个模块独立的 CLAUDE.md 文件
- 大幅减少单次处理的上下文长度
- 提高 Claude 处理效率和准确性

### 开发体验
- 根据工作内容选择对应模块
- 模块化的文档更聚焦和专业
- 自动维护文档时间戳

### 项目结构
```
photography/
├── CLAUDE.md                    # 项目概览和模块导航
├── frontend/CLAUDE.md          # 前端开发指导
├── docs/deployment/CLAUDE.md   # 部署配置指导
├── .gitea/workflows/CLAUDE.md  # CI/CD 流程指导
└── scripts/update-claude-docs.sh # 自动更新脚本
```

现在 Claude 工作时只需关注单个模块的文档,大幅提升处理效率!
2025-07-09 10:54:08 +08:00

67 lines
1.6 KiB
Markdown

# 项目脚本
本目录包含项目维护和自动化脚本。
## 脚本说明
### update-claude-docs.sh
**用途**: 自动更新各模块的 CLAUDE.md 文档时间戳
**功能**:
- 检测项目文件变更
- 自动更新相关模块的 CLAUDE.md 最后更新时间
- 验证所有 CLAUDE.md 文件完整性
**使用方法**:
```bash
# 手动运行
./scripts/update-claude-docs.sh
# 自动运行 (通过 pre-commit hooks)
git commit -m "update: 修改前端组件" # 自动触发
```
**触发条件**:
- `frontend/` 目录变更 → 更新 `frontend/CLAUDE.md`
- `docs/deployment/` 目录变更 → 更新 `docs/deployment/CLAUDE.md`
- `.gitea/workflows/` 目录变更 → 更新 `.gitea/workflows/CLAUDE.md`
- `CLAUDE.md` 变更 → 更新根目录时间戳
## 自动化集成
### Pre-commit Hooks
脚本已集成到 pre-commit hooks 中,会在以下情况自动运行:
- 提交涉及模块文件变更时
- 自动更新时间戳并包含在本次提交中
### 配置文件
- **lint-staged.config.js** - 配置自动触发规则
- **package.json** - 项目脚本配置
## 最佳实践
### 开发流程
1. 正常开发和修改文件
2. 使用 `git add` 添加变更
3. 使用 `git commit` 提交(自动触发脚本)
4. 脚本自动更新相关 CLAUDE.md 文档
5. 时间戳更新会包含在提交中
### 手动维护
如果需要手动更新文档:
```bash
# 运行脚本
./scripts/update-claude-docs.sh
# 提交更新
git add .
git commit -m "docs: 更新 CLAUDE.md 文档"
```
## 扩展计划
### 未来功能
- 自动生成模块依赖图
- 检查 CLAUDE.md 文档格式
- 自动同步配置变更
- 生成变更日志