From a0c1e1935f135cc56880ddda0bb3b285c6f1558c Mon Sep 17 00:00:00 2001 From: Harshita-Kanal Date: Thu, 26 Feb 2026 00:25:45 +0530 Subject: [PATCH] docs: add agents.md and agents.yaml for AI agent development setup --- .agents/agents.md | 31 +++++++++++++++++++++++++++++++ .agents/agents.yaml | 27 +++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .agents/agents.md create mode 100644 .agents/agents.yaml diff --git a/.agents/agents.md b/.agents/agents.md new file mode 100644 index 0000000000..85be0efe5d --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,31 @@ +# react-router - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- Declarative routing for React + +## Setup +See [`agents.yaml`](./agents.yaml) for prerequisites, commands, and ports. + +### Setup Hints +- `nvm` may not be loaded in your shell. If `nvm: command not found`, source it first. +- `npm start` runs in the foreground — background it the same way. + +## Running the App +- Clone the repo +- Install: `npm install` +- Dev: `npm start &` +- Access: `http://localhost:3000` + +## Architecture +- React routing library (v3) +- Entry point: `modules/index.js` + +## Working Agreement +- Write modular code +- Keep testable +- Incremental validation +- Commit meaningful checkpoints +- Write tests +- Validate before handoff diff --git a/.agents/agents.yaml b/.agents/agents.yaml new file mode 100644 index 0000000000..23c1c8be63 --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,27 @@ +repo: + name: react-router + description: Declarative routing for React + owner: ReactTraining + +prerequisites: + - name: GitHub CLI + - name: npm + - name: node + version: '>=12.0.0' + +setup: + - npm install + - npm start + +dev: + command: npm start + port: 3000 + +build: + command: npm run build + +test: + command: npm test + +lint: + command: npm run lint