AGENTS.md for local commands, architecture rules, naming conventions, release constraints, and product context.
Do not put secrets or credentials in AGENTS.md.
Add instructions
In your project root, createAGENTS.md:
AGENTS.md
Keep instructions specific
| Include | Avoid |
|---|---|
| Test and lint commands | General TypeScript or React lessons |
| Naming and folder conventions | Veryfront framework basics |
| Deployment or release constraints | Secrets or credentials |
| Product-specific rules | Long process documents |
| Known architecture boundaries | Temporary notes that expire quickly |
Make rules actionable
| Weak | Better |
|---|---|
| Write good tests. | Run npm test after changing shared logic. |
| Follow the design system. | Use components from components/ui/ before adding new UI primitives. |
| Be careful with auth. | Do not change auth middleware without updating tests/auth.test.ts. |
| Keep copy concise. | Keep user-facing copy under two sentences per state. |
Check the result
Ask Veryfront Agent to summarize the active project instructions:Update instructions
ReviewAGENTS.md after major project changes.
Update it when commands, deployment targets, folder ownership, or product constraints change.
What to include
| Situation | Add this |
|---|---|
| New test command | The exact command and when to run it. |
| New folder convention | The owning folder and what belongs there. |
| New release rule | The release target and required validation. |
| New product constraint | The rule and an example of when it applies. |
Next
| Goal | Page |
|---|---|
| Add reusable workflows | Skills |
| Understand Agent context | Veryfront Agent |