Skip to content

Commit 60a8084

Browse files
committed
Review
1 parent 6c510d6 commit 60a8084

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

Agents.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,9 @@ react-admin/
9393
│ ├── crm/ # CRM application
9494
│ └── tutorial/ # Tutorial app
9595
├── cypress/ # E2E test configuration
96-
├── docs/ # Jekyll documentation
97-
└── scripts/ # Build scripts
96+
├── docs/ # Jekyll documentation
97+
├── docs_headless/ # Astro + Starlight documentation for headless components
98+
└── scripts/ # Build scripts
9899
```
99100

100101
### Key ra-core Directories
@@ -173,6 +174,8 @@ All documentation files must include:
173174
- Detailed usage for each prop/parameter (in alphabetical order)
174175
- Recipes and advanced usage examples if applicable
175176
177+
Headless hooks and components (the ones in `ra-core`) are also documented in the `/docs_headless/` directory.
178+
176179
### Pre-commit Hooks
177180
178181
- Automatic test execution for modified files
@@ -197,7 +200,7 @@ make prettier # Format code
197200
198201
### Pull Request Process
199202
200-
1. **Target branch**: `next` for features, `master` for bug fixes
203+
1. **Target branch**: `next` for features, `master` for bug fixes or documentation changes
201204
2. **Required checks**:
202205
- All tests passing (`make test`)
203206
- Linting clean (`make lint`)
@@ -212,13 +215,13 @@ make prettier # Format code
212215
```
213216
214217
4. **Documentation**: Update relevant docs for API changes
218+
5. **Title**: Start with a verb (Add / Fix / Update / Remove), prefix with `[Doc]` or `[TypeScript]` if the change only concerns doc or types.
215219
216220
### Common Make Commands
217221
```bash
218-
make # Show all available commands
219-
make install # Install dependencies
220-
make build # Build all packages (CJS + ESM)
221-
make watch # Development watch mode
222+
make # Show all available commands
223+
make install # Install dependencies
224+
make build # Build all packages (CJS + ESM)
222225
make test # Run all tests
223226
make lint # Check code quality
224227
make prettier # Format code
@@ -230,6 +233,7 @@ make run-demo # Run demo application
230233
231234
- Use `React.memo()` for expensive components
232235
- Leverage `useMemo()` and `useCallback()` appropriately
236+
- Use `useEvent()` (an internal hook) for memoized event handlers
233237
- Implement pagination for large datasets
234238
- Use query caching via React Query
235239

0 commit comments

Comments
 (0)