Skip to content

Commit 86ea7d5

Browse files
Add setup instructions to README, add setup script, and enforce agent restrictions in AGENTS.md
1 parent 5f72f27 commit 86ea7d5

3 files changed

Lines changed: 20 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,4 +209,6 @@ The repository does **not** contain a `.cursor/` directory or a `.github/copilot
209209

210210
---
211211

212+
**Agent Restrictions**: Agents must not modify any files outside the project directory. They also may not commit changes without explicit user permission; always ask for review before committing.
213+
212214
_End of file – agents should keep this document up to date as the project evolves._

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ Currently, two official plugins are available:
77
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
88
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
99

10+
## Setup
11+
12+
This project requires **Node ≥ 22.12.0**. If you use `nvm`, run:
13+
14+
```bash
15+
nvm install 22.12.0
16+
nvm use 22.12.0
17+
```
18+
19+
You can also use the provided npm script:
20+
21+
```bash
22+
npm run setup
23+
```
24+
25+
which will execute the above commands (assuming `nvm` is available in your shell).
26+
1027
## Expanding the ESLint configuration
1128

1229
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"type": "module",
66
"scripts": {
77
"dev": "vite",
8+
"setup": "nvm install 22.12.0 && nvm use 22.12.0",
89
"build": "tsc -b && vite build",
910
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
1011
"preview": "vite preview",

0 commit comments

Comments
 (0)