Que fait agents-md ?
Crée et maintient des fichiers d'instructions de projet concis AGENTS.md et CLAUDE.md. Utilisez-le lorsqu'on vous demande de créer AGENTS.md, mettre à jour AGENTS.md, maintenir la documentation de l'agent, configurer CLAUDE.md, documenter les conventions d'agent du dépôt ou garder les instructions de l'agent de codage minimales et basées sur des références.
Utilisation
Lorsqu'un utilisateur vous demande de configurer ou de mettre à jour la documentation d'agent pour un dépôt, utilisez cette compétence pour générer ou mettre à jour un fichier AGENTS.md (ou CLAUDE.md) à la racine du dépôt.
Format recommandé
- Titre et brève description du projet
- Pile technique et dépendances principales
- Workflows standard (construction, test, lint)
- Conventions de projet (structure, style de codage, messages de commit)
- Références clés vers les fichiers de documentation, de code ou de test pertinents
- Commandes shell courantes pour l'exécution, les tests et le débogage
Comportement typique
- Lister les fichiers importants du dépôt (package.json, go.mod, etc.)
- Identifier les scripts de construction et de test
- Résumer les conventions de contribution et de code
- Mettre l'accent sur les instructions minimales, mais suffisantes, orientées vers les références
- Ne pas dupliquer des informations déjà mises à jour dans d'autres fichiers de documentation
Exemple de sortie (AGENTS.md minimal)
# MyProject
- **Stack**: Node.js, TypeScript, Express
- **Build** : `npm run build`
- **Test** : `npm test`
- **Lint** : `npm run lint`
- **Conventions** : Prettier, ESLint, commit conventionnel
- **Références** : `./docs/architecture.md`, `./CONTRIBUTING.md`
Mises en garde
- Ne pas inclure de fichiers ou de secrets sensibles.
- Documenter de manière à ce que l'agent puisse se référer à d'autres fichiers sans avoir à les lire en entier.
- Garder les instructions personnelles (comme
CLAUDE.md) séparées des instructions partagées par l'équipe (commeAGENTS.md).