Skip to content

Commit 2404735

Browse files
authored
Merge pull request anomalyco#251 from gangqian68/main
docs: add CLAUDE.md for Claude Code guidance
2 parents 0b11849 + 66959c1 commit 2404735

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

‎CLAUDE.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
This is a **Claude Code plugin** - a collection of production-ready agents, skills, hooks, commands, rules, and MCP configurations. The project provides battle-tested workflows for software development using Claude Code.
8+
9+
## Running Tests
10+
11+
```bash
12+
# Run all tests
13+
node tests/run-all.js
14+
15+
# Run individual test files
16+
node tests/lib/utils.test.js
17+
node tests/lib/package-manager.test.js
18+
node tests/hooks/hooks.test.js
19+
```
20+
21+
## Architecture
22+
23+
The project is organized into several core components:
24+
25+
- **agents/** - Specialized subagents for delegation (planner, code-reviewer, tdd-guide, etc.)
26+
- **skills/** - Workflow definitions and domain knowledge (coding standards, patterns, testing)
27+
- **commands/** - Slash commands invoked by users (/tdd, /plan, /e2e, etc.)
28+
- **hooks/** - Trigger-based automations (session persistence, pre/post-tool hooks)
29+
- **rules/** - Always-follow guidelines (security, coding style, testing requirements)
30+
- **mcp-configs/** - MCP server configurations for external integrations
31+
- **scripts/** - Cross-platform Node.js utilities for hooks and setup
32+
- **tests/** - Test suite for scripts and utilities
33+
34+
## Key Commands
35+
36+
- `/tdd` - Test-driven development workflow
37+
- `/plan` - Implementation planning
38+
- `/e2e` - Generate and run E2E tests
39+
- `/code-review` - Quality review
40+
- `/build-fix` - Fix build errors
41+
- `/learn` - Extract patterns from sessions
42+
- `/skill-create` - Generate skills from git history
43+
44+
## Development Notes
45+
46+
- Package manager detection: npm, pnpm, yarn, bun (configurable via `CLAUDE_PACKAGE_MANAGER` env var or project config)
47+
- Cross-platform: Windows, macOS, Linux support via Node.js scripts
48+
- Agent format: Markdown with YAML frontmatter (name, description, tools, model)
49+
- Skill format: Markdown with clear sections for when to use, how it works, examples
50+
- Hook format: JSON with matcher conditions and command/notification hooks
51+
52+
## Contributing
53+
54+
Follow the formats in CONTRIBUTING.md:
55+
- Agents: Markdown with frontmatter (name, description, tools, model)
56+
- Skills: Clear sections (When to Use, How It Works, Examples)
57+
- Commands: Markdown with description frontmatter
58+
- Hooks: JSON with matcher and hooks array
59+
60+
File naming: lowercase with hyphens (e.g., `python-reviewer.md`, `tdd-workflow.md`)

0 commit comments

Comments
 (0)