AGENTS.md - Un format simple et ouvert pour guider les agents de codage

AGENTS.md est un format simple et ouvert conçu pour guider les agents de codage, utilisé par plus de 20 000 projets open-source. Il sert d'espace dédié pour fournir un contexte et des instructions qui aident les agents de codage IA à travailler efficacement sur des projets. Ce format complète les fichiers README.md traditionnels en se concentrant sur les besoins spécifiques des agents de codage.

1. Commandes de configuration

   • Installer les dépendances : pnpm install
   • Démarrer le serveur de développement : pnpm dev
   • Exécuter les tests : pnpm test

2. Directives de style de code

   • Mode strict TypeScript
   • Guillemets simples, pas de points-virgules
   • Préférence pour les modèles de programmation fonctionnelle

3. Compatibilité des agents

   AGENTS.md fonctionne parfaitement avec divers agents de codage IA, y compris :

   Nom de l'agent	Description
   Codex	Outils CLI polyvalents pour les agents de codage IA.
   Amp	Agent de codage IA de Google.
   Jules	Un autre agent de codage IA de Google.
   Cursor	Outil de codage IA pour une productivité accrue.
   Factory	Outil pour construire et gérer des agents de codage.
   Roo	Assistant de codage IA pour diverses tâches de programmation.
   CodeAider	Outil IA pour l'assistance et la génération de code.
   Gemini CLI	Outil CLI de Google pour les tâches de codage.
   Kilo Code	Agent de codage IA pour un développement rationalisé.
   OpenCode	Agent de codage open-source pour des projets collaboratifs.
   Phoenix	Outil IA pour améliorer l'efficacité du codage.
   Zed	Assistant de codage IA pour divers langages de programmation.

4. Fichiers AGENTS.md imbriqués

   Pour les grands monorepos, des fichiers AGENTS.md imbriqués peuvent être utilisés au sein des sous-projets, permettant des instructions adaptées pour chaque package.

1. Créez un fichier AGENTS.md à la racine de votre dépôt.
2. Incluez des sections qui aident les agents à travailler efficacement, telles que l'aperçu du projet, les commandes de construction et les instructions de test.
3. Ajoutez toute instruction supplémentaire pertinente pour les nouveaux contributeurs, telles que les messages de commit et les considérations de sécurité.
4. Pour les grands projets, utilisez des fichiers AGENTS.md imbriqués pour des sous-projets spécifiques afin de fournir des conseils localisés.

Y a-t-il des champs obligatoires dans AGENTS.md ?

Non, AGENTS.md est flexible et peut être structuré en utilisant n'importe quel en-tête selon les besoins. L'agent analysera le texte fourni.

Que se passe-t-il si les instructions sont en conflit ?

Le fichier AGENTS.md le plus proche du fichier modifié prend le pas, tandis que les invites explicites de l'utilisateur remplaceront toute instruction conflictuelle.

L'agent exécutera-t-il automatiquement les commandes de test ?

Oui, si des commandes de test sont listées dans AGENTS.md, l'agent tentera de les exécuter et de corriger les échecs.

AGENTS.md peut-il être mis à jour plus tard ?

Absolument, AGENTS.md doit être considéré comme une documentation vivante qui peut être modifiée selon les besoins.

Les données de prix ne sont pas encore disponibles ; veuillez visiter le site officiel pour plus d'informations.

1. AGENTS.md fournit efficacement un format structuré pour les agents de codage, améliorant leur capacité à comprendre les exigences du projet et à exécuter les tâches efficacement.
2. La séparation des fichiers README.md aide à maintenir la clarté pour les contributeurs humains tout en offrant des conseils détaillés pour les agents IA.
3. Cependant, l'adoption d'AGENTS.md peut nécessiter un changement culturel au sein des équipes habituées aux pratiques de documentation traditionnelles.
4. Dans l'ensemble, AGENTS.md est un outil précieux pour les développeurs cherchant à rationaliser leurs flux de travail avec des agents de codage IA, mais son succès dépend d'une utilisation et de mises à jour cohérentes.