mcpField
T
tuzi-update-claude-md

tuzi-update-claude-md

github.com/tuziapiAgent workflows39149 installsUpdated 27w ago
Repository

About tuzi-update-claude-md

A Claude Code skill for turning code-review feedback or development issues into reusable project rules. It keeps CLAUDE.md concise while placing detailed guidance and examples in companion documentation.

Key features

  1. 01Extracts reusable rules from issues
  2. 02Separates summary and detailed guidance
  3. 03Checks project and user EXTEND.md settings
  4. 04Checks existing rules for duplicates
  5. 05Supports priority-based documentation updates

Use cases

  1. 01Record a recurring bug-prevention rule
  2. 02Add detailed coding examples to project docs
  3. 03Apply custom documentation preferences
  4. 04Review recent changes for undocumented rules

Install

Copy the command and run it in a terminal.

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

After installing, type/tuzi-update-claude-mdin Claude Code to confirm it loaded.

Details

From the project README

Update CLAUDE.md

Analyzes code review feedback or development issues, extracts general rules, and updates documentation with a layered strategy (summary in CLAUDE.md, details in docs/CODING_RULES.md).

Core Principle

CLAUDE.md must stay concise. Summary rules only, 1-2 sentences each.

DocumentContentLine Limit
CLAUDE.mdCore summary rules (1-2 sentences)≤ 300 lines
docs/CODING_RULES.mdDetailed rules + error/correct examplesNo limit
docs/FEATURE_FLOWS.mdFeature flow documentationNo limit

Parameters

  • $ARGUMENTS: Description of the discovered issue or rule (optional)

Preferences (EXTEND.md)

Use Bash to check EXTEND.md existence (priority order):

# 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"

┌──────────────────────────────────────────────────────────┬───────────────────┐ │ Path │ Location │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ .tuzi-skills/tuzi-update-claude-md/EXTEND.md │ Project directory │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ $HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md │ User home │ └──────────────────────────────────────────────────────────┴───────────────────┘

┌───────────┬───────────────────────────────────────────────────────────────────────────┐ │ Result │ Action │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ Found │ Read, parse, apply settings │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ Not found │ Use defaults │ └───────────┴───────────────────────────────────────────────────────────────────────────┘

EXTEND.md Supports: CLAUDE.md line limit | Rule categories | Commit message format

Workflow

Step 1: Gather Information

If $ARGUMENTS provided: Parse the described issue or rule.

If no arguments: Ask user what issue was discovered, or check recent git diff and commit messages:

git diff HEAD~3 --stat
git log --oneline -5
Step 2: Assess Rule Priority
PriorityCriteriaAction
HighFrequent error pattern, causes serious bugs, core project conventionAdd to both CLAUDE.md + CODING_RULES.md
NormalOccasional issue, scenario-specific, detailed examplesOnly CODING_RULES.md
SkipOne-off typo, overly specific business logic, already coveredDo not record
Step 3: Check Document Status
wc -l CLAUDE.md

If over 250 lines, prompt user to clean up before adding.

Step 4: Update docs/CODING_RULES.md

Add to the appropriate section using this format:

### [Issue Title]

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

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

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

**Reason**: [Why]

Section categories: TypeScript | React Components | Service Worker | Cache & Storage | API & Task Processing | UI Interaction

Step 5: Update CLAUDE.md (High Priority Only)

Add 1-2 sentence summary only:

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

Location: Under ## 核心编码规则 or equivalent section.

Step 6: Check for Duplicates
  • Check both CLAUDE.md and CODING_RULES.md for similar existing rules
  • Supplement existing rules rather than creating new ones
  • Avoid document bloat from redundancy
Step 7: Confirm Update

Display summary:

## 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
Step 8: Commit
git add CLAUDE.md docs/CODING_RULES.md
git commit -m "docs: add coding rule - [rule name]"

Periodic Cleanup

When CLAUDE.md approaches 300 lines:

  1. Merge similar rules
  2. Remove outdated rules
  3. Move overly detailed rules to CODING_RULES.md
  4. Update cross-references

Example Usage

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

# Interactive
/tuzi-update-claude-md

Extension Support

Custom configurations via EXTEND.md. See Preferences section for paths and supported options.

Comments

Markdown supported