diff --git a/.agents/agents.md b/.agents/agents.md new file mode 100644 index 0000000..c1f701d --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,32 @@ +# react-collapsable - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- A Collapsable React Component + +## 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 storybook` runs in the foreground — background it the same way. + +## Running the App +- Clone the repo +- Install: `yarn install` +- Dev: `yarn storybook &` +- Access: `http://localhost:6006` + +## Architecture +- React component library with Storybook +- Uses Emotion for styling +- Entry point: `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 0000000..603ee4c --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,27 @@ +repo: + name: react-collapsable + description: A Collapsable React Component + owner: dahliacreative + +prerequisites: + - name: GitHub CLI + - name: yarn + - name: node + version: '>=14.0.0' + +setup: + - yarn install + - yarn storybook + +dev: + command: yarn storybook + port: 6006 + +build: + command: yarn build + +test: + command: yarn test + +lint: + command: yarn lint