Skip to content

Commit d1627cb

Browse files
Copilothi-ogawa
andauthored
chore: add AGENTS.md documentation for AI agent development guidance (#820)
Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hi-ogawa <[email protected]>
1 parent 768cfd3 commit d1627cb

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AI Agent Development Guide
2+
3+
This document provides AI-agent-specific guidance for working with the vite-plugin-react monorepo. For comprehensive documentation, see:
4+
5+
- **[README.md](README.md)** - Repository overview and package links
6+
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Setup, testing, debugging, and contribution guidelines
7+
8+
## Quick Reference for AI Agents
9+
10+
### Repository Navigation
11+
12+
This monorepo contains multiple packages (see [README.md](README.md#packages) for details):
13+
14+
- `packages/plugin-react/` - Main React plugin with Babel
15+
- `packages/plugin-react-swc/` - SWC-based React plugin
16+
- `packages/plugin-rsc/` - React Server Components ([AI guidance](packages/plugin-rsc/AGENTS.md))
17+
- `packages/plugin-react-oxc/` - Deprecated (merged with plugin-react)
18+
19+
### Essential Setup Commands
20+
21+
```bash
22+
pnpm install && pnpm build # Initial setup (see CONTRIBUTING.md for details)
23+
pnpm dev # Watch mode development
24+
pnpm test # Run all tests
25+
```

packages/plugin-rsc/AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AI Agent Guide for @vitejs/plugin-rsc
2+
3+
This document provides AI-agent-specific guidance for the React Server Components (RSC) plugin. For comprehensive documentation, see:
4+
5+
- **[README.md](README.md)** - Plugin overview, concepts, and examples
6+
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development setup and testing guidelines
7+
8+
## Quick Reference for AI Agents
9+
10+
### Essential Commands
11+
12+
```bash
13+
# inside packages/plugin-rsc directory
14+
pnpm build # build package
15+
pnpm tsc # typecheck
16+
pnpm dev # Watch mode development
17+
pnpm test-e2e # Run e2e tests
18+
pnpm test-e2e basic # Test specific example
19+
```

0 commit comments

Comments
 (0)