IA Agent Débutant
AGENTS.md, le guide des agents IA dans un projet
Un fichier AGENTS.md à la racine d'un dépôt donne aux agents IA les règles du projet, comme un README pour les machines.
agentsagents.mdcontextebonnes-pratiques
Définition
AGENTS.md est un fichier Markdown placé dans un dépôt. Il donne à un agent IA de code le contexte dont il a besoin pour travailler : comment installer le projet, lancer les tests, respecter les conventions, et ce qu’il ne doit pas faire. On peut le voir comme un README écrit pour les agents.
Pourquoi l’utiliser
Un agent ne connaît pas votre projet. Sans consigne, il devine : mauvaise commande de test, style différent, fichiers modifiés par erreur. Un fichier unique et versionné évite de répéter les mêmes instructions à chaque conversation, et il s’applique à toute l’équipe.
Que mettre dedans
| Section | Contenu utile |
|---|---|
| Commandes | Installer, lancer, tester, construire |
| Conventions | Langue, style de code, nommage, commentaires |
| Architecture | Où se trouvent les dossiers importants |
| Limites | Ce qu’il ne faut pas modifier ou lancer |
| Validation | Comment vérifier qu’une tâche est terminée |
Exemple de code
# AGENTS.md
## Commandes
- Installer : `npm install`
- Tester : `npm test`
- Construire : `npm run build`
## Conventions
- Commentaires en français.
- Un composant par fichier.
## Limites
- Ne jamais modifier `dist/`.
- Demander avant de supprimer un fichier.Utilisation dans un projet
- Créer
AGENTS.mdà la racine du dépôt et le versionner avec le code. - Y écrire les commandes exactes, celles que l’on tape vraiment.
- Ajouter un
AGENTS.mddans un sous-dossier pour des règles propres à cette partie. Le plus proche du fichier travaillé s’applique en priorité. - Relire le fichier quand le projet change, comme n’importe quelle documentation.
- Observer le comportement de l’agent, puis préciser les consignes qu’il a mal comprises.
Erreurs fréquentes
- Un fichier trop long : l’agent perd l’essentiel. Viser court et concret.
- Des consignes vagues comme « écris du bon code ». Préférer une règle vérifiable.
- Des informations périmées qui contredisent le code réel.
- Des secrets ou des clés : le fichier est public dans le dépôt.