Skip to content

add an AGENTS.md #505

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

Merged
bgentry merged 1 commit into from
Feb 6, 2026
+23 −0
Merged

add an AGENTS.md #505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# River UI Agent Guidelines

## Commands
- Dev: `npm run dev` (pro: `npm run dev:pro`)
- Lint/format: `npm run lint`, `npm run fmt`
- Tests: `npm run test`, `npm run test:once`, `npm exec -- vitest --run path/to/file.test.tsx`
- Build: `npm run build`, `make build`
- Go lint/test: `make lint`, `make test`

## Rules
- No `any`; use `unknown` or specific types.
- Tests live beside components (`.test.tsx`).
- Prefix unused variables with `_`.

## Validate
- UI/router/search-state: targeted tests + `npm run lint`.
- Larger changes: `npm run test:once` + `npm run build`.
- Go changes: `make lint`.

## Commits
- Title <= 50 chars (max 72); wrap body ~72.
- Explain problem, fix, why it works, and tests.
- Use auto-close keywords; don’t mention "ran lint/tests".
Loading