docs: describe dev env for agents

[wesleyboar]

Overview

Documents dev environment for Agents via AGENTS.md.

I created this PR with a Cursor Cloud Agents with Computer Use. It also wrote some of this PR description. The screenshots and video are from its dev environment.

Related

• mimics feat: document dev env for agents wesleyboar/Core-Components#1
• similar to TACC/Core-CMS#1106 AGENTS.md

Changes

• added AGENTS.md

Testing

1. npm install --include=optional:
   ✅ Dependencies installed successfully.
2. npm test -- --run:
   ✅ All tests passed (93 passed, 2 skipped, 1 todo).
3. npm run build:
   ✅ Build succeeded (Vite library build + TypeScript declarations generated).
4. npm run lint:
   ⚠️ ESLint is not a project dependency, and .eslintrc.json is a stub (pre-existing repo state).
5. npm start:
   ✅ Storybook dev server started successfully on port 9000.
6. Manual Testing:
   Verified Storybook UI by navigating to Button and Paginator components, and interacting with controls (e.g., isLoading prop on Button).

Screenshots

storybook_demo_button_paginator.mp4

paginator	button

---

  

[qodo-code-review]

Review Summary by Qodo

Add AGENTS.md documentation for Cursor Cloud agents

📝 Documentation

Walkthroughs

Description

• Added AGENTS.md with Cursor Cloud agent instructions
• Documents project setup, key npm commands, and dependencies
• Highlights ESLint, Storybook, and peer dependency caveats

Diagram

flowchart LR
  A["Project Documentation"] -->|"adds agent guide"| B["AGENTS.md"]
  B -->|"documents"| C["Commands & Setup"]
  B -->|"documents"| D["Caveats & Issues"]

Loading

File Changes

1. AGENTS.md 📝 Documentation +20/-0

New agent-specific development guide

• Created new documentation file for Cursor Cloud agent instructions
• Documents key npm commands (start, test, build, lint)
• Lists three important caveats: ESLint not installed, optional Storybook deps, peer dependencies
 resolution
• Provides quick reference for development environment setup

AGENTS.md

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (3) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Peer deps cause misguidance ☑ 🐞 Bug ⛯ Reliability

Description

AGENTS.md claims peers (React/Formik/etc.) come from Storybook transitive deps, but the lockfile
shows they’re installed as auto-resolved peer dependencies (e.g., via @testing-library/react). This
can mislead developers/agents and will break in environments/package managers that don’t
auto-install peers (or behave differently).

Code

AGENTS.md[20]

+- **Peer dependencies** (React, Formik, Reactstrap, etc.) are resolved from Storybook's transitive deps during development. They are not installed as direct devDependencies.

Evidence

The repo declares React/Formik/etc. as peerDependencies (not devDependencies), yet package-lock
shows they are installed with "peer": true, indicating npm peer auto-resolution rather than being
“Storybook transitive deps”. Additionally, @testing-library/react (a devDependency) declares
peerDependencies on react/react-dom, which can drive that peer installation independent of
Storybook.

AGENTS.md[18-20]
package.json[27-37]
package-lock.json[7488-7506]
package-lock.json[17084-17096]
package-lock.json[11552-11577]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`AGENTS.md` states that peer deps (React/Formik/etc.) are resolved from Storybook’s transitive dependencies. In this repo, the lockfile indicates these packages are installed as *peer-resolved* modules (e.g., driven by tooling like `@testing-library/react`), which is different from “Storybook transitive deps” and can fail under package managers/modes that don’t auto-install peers.
### Issue Context
- The package declares many runtime libraries as `peerDependencies`, not `devDependencies`.
- `package-lock.json` shows `react`/`formik` are installed with `"peer": true`.
- Tooling like `@testing-library/react` has peerDependencies on `react`/`react-dom`, which can trigger npm’s peer auto-install.
### Fix Focus Areas
- AGENTS.md[20-20]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. ESLint guidance not reproducible ☑ 🐞 Bug ⛯ Reliability

Description

AGENTS.md recommends installing ESLint globally, but the repo does not declare eslint as a
dependency and the eslint config is effectively empty. Following the doc yields a non-reproducible
setup and still won’t provide meaningful linting across environments/CI.

Code

AGENTS.md[18]

+- **ESLint is not a project dependency.** The `npm run lint` script calls `eslint .` but `eslint` is not listed in `package.json`. The `.eslintrc.json` config is a stub with no parser or plugins, so linting does not currently function. Install eslint@8 globally (`npm install -g eslint@8`) if needed.

Evidence

npm run lint is defined as eslint . but eslint is not in dependencies/devDependencies. Also
.eslintrc.json contains empty overrides and no parser/plugins/options, so even once eslint is
installed, linting is not configured meaningfully.

AGENTS.md[18-18]
package.json[16-23]
package.json[38-50]
.eslintrc.json[1-16]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`AGENTS.md` instructs users to install `eslint@8` globally, but the project does not declare eslint as a dependency and the eslint configuration is a stub. This makes linting non-reproducible and (even after a global install) not meaningfully configured.
### Issue Context
- `package.json` defines `lint: "eslint ."`.
- `eslint` is not present in `dependencies` or `devDependencies`.
- `.eslintrc.json` contains empty overrides and no parser/plugins/options.
### Fix Focus Areas
- AGENTS.md[18-18]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

3. Optional deps wording overstated ☑ 🐞 Bug ✓ Correctness

Description

AGENTS.md says plain npm install omits optional dependencies; this is likely overstated for
default npm behavior and could confuse readers. The README already recommends `npm install
--include=optional`, so consider rewording to “some environments omit optional deps; use … to be
safe”.

Code

AGENTS.md[19]

+- **Storybook deps are optional.** Always use `npm install --include=optional` to get Storybook packages; plain `npm install` omits them.

Evidence

The repo indeed places Storybook packages under optionalDependencies and the README already
instructs npm install --include=optional. However, AGENTS.md adds an additional claim (“plain npm
install omits them”) that is not demonstrated anywhere in repo configuration.

AGENTS.md[19-19]
package.json[54-59]
README.md[80-85]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`AGENTS.md` states that plain `npm install` omits optionalDependencies. This claim isn’t backed by repo config and is likely to confuse. The safer doc is to keep `--include=optional` as a defensive step without asserting default npm behavior.
### Issue Context
- Storybook packages are declared under `optionalDependencies`.
- README already recommends `npm install --include=optional`.
### Fix Focus Areas
- AGENTS.md[19-19]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more