<aside> 💡

Content: Onboard your AI engineer

</aside>

Goal: Create a comprehensive AGENTS.md file that provides essential context for AI coding agents working on your project.

Instructions: Send this prompt to your coding agent

Tell me about my codebase, including:
- The project purpose and key product features
- Tech stack (frontend frameworks, backend libraries, databases)
- Folder structure and organization
- How to build and run the app
- How to test the app
- Any important setup commands or dependencies

Then based on the result, ask it to create your AGENTS.md file:

Put your findings concisely in AGENTS.md with the following format:

## Codebase overview
## Product features
## Tech stack
## Folder structure
## Building the app
## Testing

Keep it focused on the most salient information - just what a new engineer would need to get started.

Finally, add coding best practices.

Add principles on what good coding practice looks like into AGENTS.md, focusing on simplicity, readability, incremental building, using standard libraries, and no premature optimization under a section called: HOW TO CODE.

Create a specs/ folder and add your first specification

Create a specs/ folder in your project root and add a spec file describing a key feature or component. For example:

mkdir specs
# Then create specs/feature-name.md with:
# - Feature description
# - Requirements
# - Implementation notes
# - Edge cases to consider

Update AGENTS.md to mention the specs/ folder under the Folder structure section.

Review your AGENTS.md file and verify it contains the essential context without overwhelming detail. Remember: the goal is to create a "README for agents" - concise but comprehensive.