Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 7, 2025
Merged

chore: add AGENTS.md documentation for AI agent development guidance #820

merged 4 commits into from
Sep 7, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 7, 2025 •
edited
Loading

This PR adds AGENTS.md documentation files to provide AI-agent-specific guidance for working with the vite-plugin-react monorepo.

Files Added

Root AGENTS.md

  • Quick reference for AI agents with essential commands and repository navigation
  • Links to existing comprehensive documentation (README.md and CONTRIBUTING.md)
  • Simplified based on feedback to avoid redundant content

packages/plugin-rsc/AGENTS.md

  • AI-specific guidance for the React Server Components plugin
  • Essential commands including both watch and non-watch modes
  • References to comprehensive documentation in README.md and CONTRIBUTING.md

Purpose

These documentation files serve as focused guides for AI agents to:

  • Quickly navigate the monorepo structure and find relevant existing documentation
  • Access essential commands without duplicating existing comprehensive documentation
  • Reference existing tools and patterns appropriately

The documentation provides minimal, targeted guidance while linking to comprehensive existing documentation for detailed setup, testing procedures, and contribution guidelines.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Copilot @hi-ogawa
Add AGENTS.md files at root and packages/plugin-rsc
2d8b507 
Co-authored-by: hi-ogawa <4232207+hi-ogawa@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Add AGENTS.md at the root and at packages/plugin-rsc Add AGENTS.md documentation for AI agent development guidance Sep 7, 2025
@Copilot Copilot AI requested a review from hi-ogawa September 7, 2025 07:38
Copilot finished work on behalf of hi-ogawa September 7, 2025 07:38
hi-ogawa
hi-ogawa reviewed Sep 7, 2025
View reviewed changes
Copy link
Contributor

@hi-ogawa hi-ogawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot explain how is this different from just linking README.md and CONTRIBUTING.md etc... from AGENTS.md

@hi-ogawa hi-ogawa marked this pull request as ready for review September 7, 2025 07:40
@hi-ogawa hi-ogawa changed the title Add AGENTS.md documentation for AI agent development guidance chore: add AGENTS.md documentation for AI agent development guidance Sep 7, 2025
@Copilot @hi-ogawa
Refactor AGENTS.md files to reference existing documentation
1098fcb 
Co-authored-by: hi-ogawa <4232207+hi-ogawa@users.noreply.github.com>
@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Sep 7, 2025

@copilot explain how is this different from just linking README.md and CONTRIBUTING.md etc... from AGENTS.md

You're absolutely right - I've refactored the AGENTS.md files to primarily reference existing documentation (README.md and CONTRIBUTING.md) rather than duplicating content. The files now focus on AI-agent-specific guidance like navigation tips, workflow recommendations, and quick reference commands while linking to comprehensive docs for detailed setup and testing procedures. This maintains the value of having AI-specific guidance without redundant documentation. (commit: 1098fcb)

@Copilot Copilot AI changed the title chore: add AGENTS.md documentation for AI agent development guidance Add AGENTS.md documentation for AI agent development guidance Sep 7, 2025
@Copilot Copilot AI requested a review from hi-ogawa September 7, 2025 07:46
Copilot finished work on behalf of hi-ogawa September 7, 2025 07:46
hi-ogawa
hi-ogawa reviewed Sep 7, 2025
View reviewed changes
packages/plugin-rsc/AGENTS.md Outdated
### Essential Commands

```bash
pnpm -C packages/plugin-rsc dev # Watch mode development
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot suggest non watch mode e.g.

# inside packages/plugin-rsc directory
pnpm build # build package
pnpm tsc # typecheck

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added non-watch mode commands pnpm build and pnpm tsc to the Essential Commands section. (commit: d986673)

packages/plugin-rsc/AGENTS.md Outdated
3. Examine RSC streams and client/server manifests
4. Verify HMR behavior across environments

For detailed setup, testing procedures, and architectural deep-dives, refer to the comprehensive documentation in [README.md](README.md) and [CONTRIBUTING.md](CONTRIBUTING.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove repetitive

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the repetitive documentation reference at the end. (commit: d986673)

packages/plugin-rsc/AGENTS.md Outdated
- `rsc/`, `ssr/`, `browser/` - Runtime APIs
- `examples/` - Test applications and learning resources

### Debugging RSC Issues
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot this looks random.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the "Debugging RSC Issues" section. (commit: d986673)

packages/plugin-rsc/AGENTS.md Outdated

## Quick Reference for AI Agents

### Key Plugin Concepts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the "Key Plugin Concepts" section. (commit: d986673)

packages/plugin-rsc/AGENTS.md Outdated

### AI-Specific Development Tips

#### Making RSC Changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot looks random

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the "Making RSC Changes" section. (commit: d986673)

AGENTS.md
- `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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove all below.

Copy link
Contributor Author

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)

@Copilot @hi-ogawa
Address feedback: simplify AGENTS.md files and add non-watch mode com…
d986673 
…mands

Co-authored-by: hi-ogawa <4232207+hi-ogawa@users.noreply.github.com>
@Copilot Copilot AI requested a review from hi-ogawa September 7, 2025 08:00
Copilot finished work on behalf of hi-ogawa September 7, 2025 08:00
@hi-ogawa hi-ogawa changed the title Add AGENTS.md documentation for AI agent development guidance chore: Add AGENTS.md documentation for AI agent development guidance Sep 7, 2025
@hi-ogawa hi-ogawa changed the title chore: Add AGENTS.md documentation for AI agent development guidance chore: add AGENTS.md documentation for AI agent development guidance Sep 7, 2025
@hi-ogawa hi-ogawa merged commit d1627cb into main Sep 7, 2025
21 of 41 checks passed
@hi-ogawa hi-ogawa deleted the copilot/fix-10a06c36-9ef3-4d30-876c-19082368df08 branch September 7, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hi-ogawa hi-ogawa Awaiting requested review from hi-ogawa

Assignees

@hi-ogawa hi-ogawa

Copilot code review Copilot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Copilot @hi-ogawa