AGENTS.md
# Agent Instructions Use this file to guide coding agents working in this repository. ## Project Context - Project type: Next.js - Tech stack: Next.js, TypeScript, React, CSS modules - Coding style: Prefer small components, explicit types, accessible UI, and existing project patterns. - AI tool target: AGENTS.md ## Project Commands - Package manager: npm - Test: `npm test` - Build: `npm run build` - Lint: `npm run lint` ## Working Agreement - Read nearby files and reuse established project patterns. - Make small, reviewable changes. - Do not introduce new dependencies unless they clearly reduce complexity. - Keep user-facing text concise and accessible. - Preserve unrelated user changes in the working tree. ## Validation 1. Run `npm run lint` for style and static checks. 2. Run `npm test` for behavior. 3. Run `npm run build` before release or handoff. ## Extra Instructions Before handoff, summarize changed files and mention any checks that could not be run.
Use the AGENTS.md generator to document how coding agents should inspect, edit, test, and hand off work in your repository. This is useful when multiple agents or automation tools need the same project context.
Why AGENTS.md Helps
AGENTS.md gives agent workflows a portable source of truth. It can describe repo layout, validation commands, safety expectations, and how to summarize changes after a task.
Best Practices
Keep instructions stable, avoid secrets, and prefer commands that a developer can run locally. If a command is slow, document both the targeted check and the full release check.
FAQ
Is AGENTS.md tool-specific?
No. It is useful as a portable instruction file across different coding agents.
What should AGENTS.md avoid?
Avoid private tokens, vague style slogans, and commands that no longer work.