Skip to content

docs: strengthen RAC convention guidance in AGENTS.md #1929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cmwinters wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: strengthen RAC convention guidance in AGENTS.md #1929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
452d945
docs: strengthen RAC convention guidance in AGENTS.md
cmwinters Jun 8, 2026
96dfe51
Merge branch 'main' into cwinters/docs/rac-convention-guidance
cmwinters Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .changeset/agents-md-rac-convention-guidance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

docs: strengthen RAC convention guidance in AGENTS.md — direct agents to follow React Aria/React Spectrum API conventions (not only behavior) and to consult React Aria first when exploring new problems. No package changes.
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ A package's typical shape: `src/` (one `.tsx` per component, plus `index.ts` bar
Follow these when writing or changing component code:

- **Use existing LaunchPad components and packages** (`@launchpad-ui/components`, `@launchpad-ui/icons`, etc.). Never create a custom component when a LaunchPad equivalent exists.
- **React Aria Components is the foundation.** Wrap and theme RAC primitives; do not reimplement keyboard/ARIA/focus behavior. The sanctioned escape hatches are `defaultProps`, slots, `useContextProps`, and render-props composition — see https://react-aria.adobe.com/customization. (`docs/adr-008-component-foundation.md`)
- **React Aria Components is the foundation.** Wrap and theme RAC primitives; do not reimplement keyboard/ARIA/focus behavior. The sanctioned escape hatches are `defaultProps`, slots, `useContextProps`, and render-props composition — see https://react-aria.adobe.com/customization. **Follow RAC's API conventions, not only its behavior:** when adding a prop, variant, or composition pattern, mirror the names and shapes RAC — and its reference implementation, [React Spectrum](https://react-spectrum.adobe.com) — already use (e.g. `description`/`errorMessage` for helper and validation text, `isDisabled`/`isInvalid` booleans, slot-based composition) rather than inventing new ones. Deviate only with a reason noted in the PR. (`docs/adr-008-component-foundation.md`)

@apucacao apucacao Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how much this matters ultimately, but RAC added markdown versions of all their pages, accessible by appending .md to any URL, like https://react-aria.adobe.com/customization.md.

Again, not that I've measured anything here, but if the agent actually does decide to go read the docs, the markdown version would eat up fewer tokens, so you may want to use that version for links here.

@cmwinters cmwinters Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw that! They've also got a 'copy for LLM' button that also copies a docs page as markdown. Great idea, I will add this to our Jira backlog.

- **Consult React Aria when exploring a new problem.** Before designing a new component, prop, or interaction, check how RAC and React Spectrum model the same thing and follow their lead. Their docs are the default starting reference, not a fallback — reaching for a blank-slate or external design when RAC already has a sanctioned pattern is the most common source of API drift (including drift from the Figma library, which mirrors these conventions).
- **Named exports only.** `export default` is reserved for stories and config files (Biome-enforced).
- **Named imports** following `import { Button, Alert } from '@launchpad-ui/components'` and `import { Icon } from '@launchpad-ui/icons'`.
- **String union prop types, never enums** (`size="medium"`, not `Size.Medium`). (`docs/adr-002-string-unions-for-prop-types.md`)
Expand Down
Loading