A collection of
AGENTS.mdtemplates for guiding AI assistants.
Use these AGENTS.md files to provide clear instructions for AI coding assistants, ensuring they align with your project's standards and technologies.
An AGENTS.md file serves as a set of instructions for an external AI helper, like a coding assistant in your IDE or a chatbot. Think of it as a CONTRIBUTING.md for AI collaborators. It sets the rules of engagement, defines the project's boundaries, and clarifies how the AI can be most helpful.
The goal is to leverage AI assistance effectively for development tasks like debugging, refactoring, documentation, and testing.
- Choose the
AGENTS.mdtemplate that best fits your project's technology stack. - Copy the file into the root of your repository and name it
AGENTS.md. - Customize it with specific details about your project (e.g., build commands, test scripts, coding standards).
This repository provides a set of templates to start from:
AGENTS.md: A generic template suitable for any project. It provides a good starting point for customization.AGENTS.php.md: A template for general PHP projects, with guidelines for PHPUnit and PSR-12 standards.AGENTS.php.laravel.md: A template for Laravel projects, including instructions for Pest and Artisan commands.AGENTS.bash.bats.md: A template for Bash projects that use BATS for testing.