Skip to content

Commit d986673

Browse files
Copilothi-ogawa
andcommitted
Address feedback: simplify AGENTS.md files and add non-watch mode commands
Co-authored-by: hi-ogawa <[email protected]>
1 parent 1098fcb commit d986673

File tree

2 files changed

+6
-72
lines changed

2 files changed

+6
-72
lines changed

AGENTS.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -23,34 +23,3 @@ pnpm install && pnpm build # Initial setup (see CONTRIBUTING.md for details)
2323
pnpm dev # Watch mode development
2424
pnpm test # Run all tests
2525
```
26-
27-
### AI-Specific Workflow Tips
28-
29-
1. **Start with existing documentation** - Always read package-specific READMEs before making changes
30-
2. **Use playground tests** - Each package has `playground/` examples for testing changes
31-
3. **Focus on minimal changes** - Prefer surgical edits over large refactors
32-
4. **Test early and often** - Run `pnpm test` after each logical change
33-
5. **Follow existing patterns** - Study similar implementations in the codebase first
34-
35-
### Common Development Tasks
36-
37-
#### Making Changes to Plugin Logic
38-
39-
1. Read the package README and existing code patterns
40-
2. Use `pnpm dev` for watch mode during development
41-
3. Test changes with relevant playground examples
42-
4. Run tests: `pnpm test-serve` and `pnpm test-build`
43-
44-
#### Debugging Build Issues
45-
46-
1. Check individual package builds with `pnpm --filter ./packages/<name> build`
47-
2. Use playground tests to isolate problems
48-
3. See [CONTRIBUTING.md debugging section](CONTRIBUTING.md#debugging) for detailed guidance
49-
50-
#### Adding Tests
51-
52-
1. Follow patterns in existing `__tests__` directories
53-
2. Use playground integration tests for feature verification
54-
3. See [CONTRIBUTING.md testing section](CONTRIBUTING.md#running-tests) for comprehensive testing guide
55-
56-
For detailed development setup, testing procedures, and contribution guidelines, refer to [CONTRIBUTING.md](CONTRIBUTING.md).

packages/plugin-rsc/AGENTS.md

Lines changed: 6 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,48 +7,13 @@ This document provides AI-agent-specific guidance for the React Server Component
77

88
## Quick Reference for AI Agents
99

10-
### Key Plugin Concepts
11-
12-
The RSC plugin creates three environments (see [README.md Basic Concepts](README.md#basic-concepts) for diagrams):
13-
14-
- **rsc** - Server component rendering
15-
- **ssr** - Server-side rendering
16-
- **client** - Browser hydration
17-
1810
### Essential Commands
1911

2012
```bash
21-
pnpm -C packages/plugin-rsc dev # Watch mode development
22-
pnpm -C packages/plugin-rsc test-e2e # Run e2e tests
23-
pnpm -C packages/plugin-rsc test-e2e basic # Test specific example
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
2419
```
25-
26-
### AI-Specific Development Tips
27-
28-
#### Making RSC Changes
29-
30-
1. **Start with `examples/starter/`** - Best learning resource for understanding RSC flows
31-
2. **Use `examples/basic/` for testing** - Comprehensive test suite with routing
32-
3. **Test across all environments** - Verify rsc, ssr, and client functionality
33-
4. **Check virtual modules** - Important for RSC manifest and reference handling
34-
35-
#### Testing Patterns
36-
37-
- **examples/basic** - Add test cases to `src/routes/`, update routing, add tests to `e2e/basic.test.ts`
38-
- **setupInlineFixture** - For isolated edge cases (see `e2e/ssr-thenable.test.ts` pattern)
39-
40-
#### Important File Locations
41-
42-
- `src/plugin.ts` - Main plugin implementation
43-
- `src/environment/` - Environment-specific logic
44-
- `rsc/`, `ssr/`, `browser/` - Runtime APIs
45-
- `examples/` - Test applications and learning resources
46-
47-
### Debugging RSC Issues
48-
49-
1. Use `examples/starter` for basic reproduction
50-
2. Check environment builds in `.vite/` directory
51-
3. Examine RSC streams and client/server manifests
52-
4. Verify HMR behavior across environments
53-
54-
For detailed setup, testing procedures, and architectural deep-dives, refer to the comprehensive documentation in [README.md](README.md) and [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)