-
-
Notifications
You must be signed in to change notification settings - Fork 188
chore: add AGENTS.md documentation for AI agent development guidance #820
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
hi-ogawa
merged 4 commits into
main
from
copilot/fix-10a06c36-9ef3-4d30-876c-19082368df08
Sep 7, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1a88245
Initial plan
Copilot 2d8b507
Add AGENTS.md files at root and packages/plugin-rsc
Copilot 1098fcb
Refactor AGENTS.md files to reference existing documentation
Copilot d986673
Address feedback: simplify AGENTS.md files and add non-watch mode com…
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# AI Agent Development Guide | ||
|
||
This document provides AI-agent-specific guidance for working with the vite-plugin-react monorepo. For comprehensive documentation, see: | ||
|
||
- **[README.md](README.md)** - Repository overview and package links | ||
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Setup, testing, debugging, and contribution guidelines | ||
|
||
## Quick Reference for AI Agents | ||
|
||
### Repository Navigation | ||
|
||
This monorepo contains multiple packages (see [README.md](README.md#packages) for details): | ||
|
||
- `packages/plugin-react/` - Main React plugin with Babel | ||
- `packages/plugin-react-swc/` - SWC-based React plugin | ||
- `packages/plugin-rsc/` - React Server Components ([AI guidance](packages/plugin-rsc/AGENTS.md)) | ||
- `packages/plugin-react-oxc/` - Deprecated (merged with plugin-react) | ||
|
||
### Essential Setup Commands | ||
|
||
```bash | ||
pnpm install && pnpm build # Initial setup (see CONTRIBUTING.md for details) | ||
pnpm dev # Watch mode development | ||
pnpm test # Run all tests | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# AI Agent Guide for @vitejs/plugin-rsc | ||
|
||
This document provides AI-agent-specific guidance for the React Server Components (RSC) plugin. For comprehensive documentation, see: | ||
|
||
- **[README.md](README.md)** - Plugin overview, concepts, and examples | ||
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development setup and testing guidelines | ||
|
||
## Quick Reference for AI Agents | ||
|
||
### Essential Commands | ||
|
||
```bash | ||
# inside packages/plugin-rsc directory | ||
pnpm build # build package | ||
pnpm tsc # typecheck | ||
pnpm dev # Watch mode development | ||
pnpm test-e2e # Run e2e tests | ||
pnpm test-e2e basic # Test specific example | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot remove all below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed all content below the Essential Setup Commands section. (commit: d986673)