AGENT SKILL

codebuddy-md-improver

Audit and improve CODEBUDDY.md files in repositories. Use when user asks to check, audit, update, improve, or fix CODEBUDDY.md files. Scans for all CODEBUDDY.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CODEBUDDY.md maintenance" or "project memory optimization".

License 许可
MIT
最近更新
2026-11-12
Stars
★ 3
Forks
1

01 前言 Front Matter

name
codebuddy-md-improver
tools
Read, Glob, Grep, Bash, Edit
description
Audit and improve CODEBUDDY.md files in repositories. Use when user asks to check, audit, update, improve, or fix CODEBUDDY.md files. Scans for all CODEBUDDY.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CODEBUDDY.md maintenance" or "project memory optimization".

02 资源文件 3

03 SKILL.md 正文

CODEBUDDY.md Improver

Audit, evaluate, and improve CODEBUDDY.md files across a codebase to ensure CodeBuddy Code has optimal project context.

This skill can write to CODEBUDDY.md files. After presenting a quality report and getting user approval, it updates CODEBUDDY.md files with targeted improvements.

Workflow

Phase 1: Discovery

Find all CODEBUDDY.md files in the repository:

find . -name "CODEBUDDY.md" -o -name ".codebuddy.md" -o -name ".codebuddy.local.md" 2>/dev/null | head -50

File Types & Locations:

Type Location Purpose
Project root ./CODEBUDDY.md Primary project context (checked into git, shared with team)
Local overrides ./.codebuddy.local.md Personal/local settings (gitignored, not shared)
Global defaults ~/.codebuddy/CODEBUDDY.md User-wide defaults across all projects
Package-specific ./packages/*/CODEBUDDY.md Module-level context in monorepos
Subdirectory Any nested location Feature/domain-specific context

Note: CodeBuddy auto-discovers CODEBUDDY.md files in parent directories, making monorepo setups work automatically.

Phase 2: Quality Assessment

For each CODEBUDDY.md file, evaluate against quality criteria. See references/quality-criteria.md for detailed rubrics.

Quick Assessment Checklist:

Criterion Weight Check
Commands/workflows documented High Are build/test/deploy commands present?
Architecture clarity High Can CodeBuddy understand the codebase structure?
Non-obvious patterns Medium Are gotchas and quirks documented?
Conciseness Medium No verbose explanations or obvious info?
Currency High Does it reflect current codebase state?
Actionability High Are instructions executable, not vague?

Quality Scores:

  • A (90-100): Comprehensive, current, actionable
  • B (70-89): Good coverage, minor gaps
  • C (50-69): Basic info, missing key sections
  • D (30-49): Sparse or outdated
  • F (0-29): Missing or severely outdated

Phase 3: Quality Report Output

ALWAYS output the quality report BEFORE making any updates.

Format:

## CODEBUDDY.md Quality Report

### Summary
- Files found: X
- Average score: X/100
- Files needing update: X

### File-by-File Assessment

#### 1. ./CODEBUDDY.md (Project Root)
**Score: XX/100 (Grade: X)**

| Criterion | Score | Notes |
|-----------|-------|-------|
| Commands/workflows | X/20 | ... |
| Architecture clarity | X/20 | ... |
| Non-obvious patterns | X/15 | ... |
| Conciseness | X/15 | ... |
| Currency | X/15 | ... |
| Actionability | X/15 | ... |

**Issues:**
- [List specific problems]

**Recommended additions:**
- [List what should be added]

#### 2. ./packages/api/CODEBUDDY.md (Package-specific)
...

Phase 4: Targeted Updates

After outputting the quality report, ask user for confirmation before updating.

Update Guidelines (Critical):

  1. Propose targeted additions only - Focus on genuinely useful info:

    • Commands or workflows discovered during analysis
    • Gotchas or non-obvious patterns found in code
    • Package relationships that weren't clear
    • Testing approaches that work
    • Configuration quirks
  2. Keep it minimal - Avoid:

    • Restating what's obvious from the code
    • Generic best practices already covered
    • One-off fixes unlikely to recur
    • Verbose explanations when a one-liner suffices
  3. Show diffs - For each change, show:

    • Which CODEBUDDY.md file to update
    • The specific addition (as a diff or quoted block)
    • Brief explanation of why this helps future sessions

Diff Format:

### Update: ./CODEBUDDY.md

**Why:** Build command was missing, causing confusion about how to run the project.

```diff
+ ## Quick Start
+
+ ```bash
+ npm install
+ npm run dev  # Start development server on port 3000
+ ```

### Phase 5: Apply Updates

After user approval, apply changes using the Edit tool. Preserve existing content structure.

## Templates

See [references/templates.md](references/templates.md) for CODEBUDDY.md templates by project type.

## Common Issues to Flag

1. **Stale commands**: Build commands that no longer work
2. **Missing dependencies**: Required tools not mentioned
3. **Outdated architecture**: File structure that's changed
4. **Missing environment setup**: Required env vars or config
5. **Broken test commands**: Test scripts that have changed
6. **Undocumented gotchas**: Non-obvious patterns not captured

## User Tips to Share

When presenting recommendations, remind users:

- **`#` key shortcut**: During a CodeBuddy session, press `#` to have CodeBuddy auto-incorporate learnings into CODEBUDDY.md
- **Keep it concise**: CODEBUDDY.md should be human-readable; dense is better than verbose
- **Actionable commands**: All documented commands should be copy-paste ready
- **Use `.codebuddy.local.md`**: For personal preferences not shared with team (add to `.gitignore`)
- **Global defaults**: Put user-wide preferences in `~/.codebuddy/CODEBUDDY.md`

## What Makes a Great CODEBUDDY.md

**Key principles:**
- Concise and human-readable
- Actionable commands that can be copy-pasted
- Project-specific patterns, not generic advice
- Non-obvious gotchas and warnings

**Recommended sections** (use only what's relevant):
- Commands (build, test, dev, lint)
- Architecture (directory structure)
- Key Files (entry points, config)
- Code Style (project conventions)
- Environment (required vars, setup)
- Testing (commands, patterns)
- Gotchas (quirks, common mistakes)
- Workflow (when to do what)

04 同仓库更多 Skills

welflau
welflau/ai-dev-system

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

测试与质量前端开发
★ 3
welflau
welflau/ai-dev-system

internal-comms

A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).

邮件与沟通
★ 3
welflau
welflau/ai-dev-system

web-artifacts-builder

Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.

前端开发
★ 3
welflau
welflau/ai-dev-system

frontend-design

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.

设计师前端开发视觉设计
★ 3
welflau
welflau/ai-dev-system

algorithmic-art

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.

视觉设计
★ 3
welflau
welflau/ai-dev-system

theme-factory

Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.

视觉设计
★ 3