AI coding

Give your agent a small set of conventions and a clear description of what the app should do.

Start with the project instructions

The starter includes AGENTS.md, covering routes, handlers, forms, resources, and project commands. Ask your tool to read it before working. If your tool uses a different instructions file, point that file to AGENTS.md so you keep one source of guidance.

The At a glance page compresses the framework into a practical overview. Use Copy as Markdown on any docs page to bring its contents into a chat or coding session.

Describe the behavior

A useful request names the feature, its data, and what success looks like:

Add a feedback page where visitors enter a name and message. Store submissions in D1, show validation errors beside the fields, and redirect to the feedback list after saving. Add a migration for the table.

This maps directly to a route, a React page, a handler, a database declaration, and a migration. The agent can prepare those files; Goribu supplies local resources during development and creates or reuses production resources on deployment.

For an existing feature, include its route and describe the current and desired behavior. A reproducible error is more useful than “fix the form.”

Add your app's rules

Keep a short section in AGENTS.md for decisions specific to your app:

## App conventions

- Use pnpm for package commands.
- Keep shared UI in src/components/.
- Feedback is plain text, with a maximum of 2,000 characters.
- Validate writes in server handlers.
- Run the relevant checks and pnpm build before handoff.

Update these rules when the app changes. When upgrading Goribu, review the starter's instructions and merge useful changes with your own rules.

Review the result

Ask the agent to explain the changed behavior and the checks it ran. For a form, check success, validation errors, and pending state. For database work, inspect both the query and its migration.

pnpm typecheck
pnpm build
pnpm check

Skip pnpm typecheck in JavaScript projects. pnpm check inspects the production plan without changing resources. Keep installation, credentials, and deployment under the ownership rules in your project.

Schema migrations and Worker deployments are separate operations. A successful build does not prove that a destructive migration is safe for existing data. See D1 migrations.

Working in a chat

If the assistant cannot read your project, provide the relevant route, related helpers, the error or desired behavior, and the matching docs. Include AGENTS.md for conventions, and configuration or middleware when they affect the request.

Never paste credentials or local environment files. Describe the required variable names and use placeholder values instead.