From 7ba3774f3e255bf0c3056537dc354362f0a0f14b Mon Sep 17 00:00:00 2001 From: Harshita-Kanal Date: Thu, 26 Feb 2026 00:26:10 +0530 Subject: [PATCH] docs: add agents.md and agents.yaml for AI agent development setup --- .agents/agents.md | 32 ++++++++++++++++++++++++++++++++ .agents/agents.yaml | 27 +++++++++++++++++++++++++++ 2 files changed, 59 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..7ce870b949 --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,32 @@ +# react-select - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- The Select Component for React.js + +## 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. +- `yarn start` runs in the foreground — background it the same way. + +## Running the App +- Clone the repo +- Install: `yarn install` +- Dev: `yarn start &` +- Access: `http://localhost:3000` + +## Architecture +- React select component library (monorepo) +- Uses preconstruct for building +- Entry point: `packages/react-select/src/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..4814c6b73e --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,27 @@ +repo: + name: react-select + description: The Select Component for React.js + owner: JedWatson + +prerequisites: + - name: GitHub CLI + - name: yarn + - name: node + version: '>=14.0.0' + +setup: + - yarn install + - yarn start + +dev: + command: yarn start + port: 3000 + +build: + command: yarn build + +test: + command: yarn test + +lint: + command: yarn lint