mcpField
T
tuzi-update-claude-md

tuzi-update-claude-md

github.com/tuziapiAgent 工作流39149 次安装27 周前更新
代码仓库

关于 tuzi-update-claude-md

面向 Claude Code 的 Skill，可将代码审查反馈或开发问题整理为可复用的项目规则。它保持 CLAUDE.md 简洁，并将详细说明和示例放入配套文档。

主要功能

  1. 01从问题中提炼通用规则
  2. 02分层编排摘要与详细说明
  3. 03读取项目及用户级 EXTEND.md 设置
  4. 04检查现有规则以避免重复
  5. 05按优先级更新文档

适用场景

  1. 01记录可预防重复错误的规则
  2. 02为项目文档补充详细编码示例
  3. 03应用自定义文档偏好
  4. 04检查近期变更中未记录的规则

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tuziapi/tuzi-skills --skill tuzi-update-claude-md

安装后在 Claude Code 中输入/tuzi-update-claude-md确认已加载。

详细介绍

更新 CLAUDE.md

分析代码审查反馈或开发问题，提炼通用规则，并采用分层策略更新文档（在 CLAUDE.md 中记录摘要，在 docs/CODING_RULES.md 中记录详细内容）。

核心原则

CLAUDE.md 必须保持简洁。 只记录摘要规则，每条 1-2 句话。

文档内容行数限制
CLAUDE.md核心摘要规则（1-2 句话）≤ 300 行
docs/CODING_RULES.md详细规则 + 错误/正确示例不限
docs/FEATURE_FLOWS.md功能流程文档不限

参数

  • $ARGUMENTS：发现的问题或规则的描述（可选）

偏好设置（EXTEND.md）

使用 Bash 按优先级顺序检查 EXTEND.md 是否存在：

# Check project-level first
test -f .tuzi-skills/tuzi-update-claude-md/EXTEND.md && echo "project"

# Then user-level (cross-platform: $HOME works on macOS/Linux/WSL)
test -f "$HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md" && echo "user"

┌──────────────────────────────────────────────────────────┬───────────────────┐ │ 路径 │ 位置 │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ .tuzi-skills/tuzi-update-claude-md/EXTEND.md │ 项目目录 │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ $HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md │ 用户主目录 │ └──────────────────────────────────────────────────────────┴───────────────────┘

┌───────────┬───────────────────────────────────────────────────────────────────────────┐ │ 结果 │ 操作 │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ 找到 │ 读取、解析并应用设置 │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ 未找到 │ 使用默认设置 │ └───────────┴───────────────────────────────────────────────────────────────────────────┘

EXTEND.md 支持：CLAUDE.md 行数限制 | 规则类别 | 提交消息格式

工作流

步骤 1：收集信息

如果提供了 $ARGUMENTS：解析所描述的问题或规则。

如果没有参数：询问用户发现了什么问题，或检查最近的 git diff 和提交消息：

git diff HEAD~3 --stat
git log --oneline -5
步骤 2：评估规则优先级
优先级标准操作
高频繁出现的错误模式、会导致严重 Bug、核心项目规范同时添加到 CLAUDE.md + CODING_RULES.md
普通偶发问题、特定场景、详细示例仅添加到 CODING_RULES.md
跳过一次性拼写错误、过于具体的业务逻辑、已有相关记录不记录
步骤 3：检查文档状态
wc -l CLAUDE.md

如果超过 250 行，添加内容前提示用户先进行清理。

步骤 4：更新 docs/CODING_RULES.md

使用以下格式添加到相应章节：

### [Issue Title]

**Scenario**: [When this issue occurs]

❌ **Wrong**:
\`\`\`typescript
// incorrect code
\`\`\`

✅ **Correct**:
\`\`\`typescript
// correct code
\`\`\`

**Reason**: [Why]

章节类别：TypeScript | React Components | Service Worker | Cache & Storage | API & Task Processing | UI Interaction

步骤 5：更新 CLAUDE.md（仅限高优先级）

只添加 1-2 句话的摘要：

N. **Rule Name**: Brief description (1-2 sentences)

位置：## 核心编码规则 或等效章节下方。

步骤 6：检查重复内容
  • 检查 CLAUDE.md 和 CODING_RULES.md 中是否已有类似规则
  • 补充现有规则，而不是创建新规则
  • 避免因内容重复导致文档臃肿
步骤 7：确认更新

显示摘要：

## Documentation Updated

### docs/CODING_RULES.md
- Section: [section name]
- Added: [rule description]
- Includes: Error/correct examples + explanation

### CLAUDE.md (if applicable)
- Section: [section name]
- Added summary: [rule summary]

### Document Status
- CLAUDE.md: XXX lines (limit 300) ✅/⚠️
- CODING_RULES.md: XXX lines
步骤 8：提交
git add CLAUDE.md docs/CODING_RULES.md
git commit -m "docs: add coding rule - [rule name]"

定期清理

当 CLAUDE.md 接近 300 行时：

  1. 合并相似规则
  2. 删除过时规则
  3. 将过于详细的规则移至 CODING_RULES.md
  4. 更新交叉引用

使用示例

# With argument
/tuzi-update-claude-md Claude keeps forgetting to add theme='light' to TDesign Tooltip

# Interactive
/tuzi-update-claude-md

扩展支持

可通过 EXTEND.md 自定义配置。路径和支持选项请参阅偏好设置章节。

评论

支持 Markdown