Skip to main content

Réponse courte

AGENTS.md est un fichier d’instructions de projet pour Codex. Il indique à Codex la structure du dépôt, les commandes, les tests, le style de code, les règles de commit et les préférences de collaboration. Il est destiné aux règles stables du projet, et non aux tâches ponctuelles. Indiquez les exigences ponctuelles dans la conversation en cours.

Contenu à inclure

  • Comment installer les dépendances, démarrer le projet et lancer les tests
  • Les commandes de validation courantes
  • Le style de code et les conventions de nommage
  • Les répertoires à ne pas modifier sans précaution
  • Les vérifications requises avant de terminer
  • Les préférences de l’équipe pour la communication et les livrables

Contenu à ne pas inclure

  • Des API Keys, tokens, mots de passe ou identifiants privés
  • Des instructions temporaires de tâche
  • De longues présentations historiques du produit
  • Des consignes génériques sans lien avec le dépôt
  • Des commandes et chemins obsolètes

Structure suggérée

Erreurs fréquentes

  • Transformer AGENTS.md en une très longue consigne universelle.
  • Écrire des secrets dans le fichier.
  • Oublier de le mettre à jour lorsque les commandes du projet changent.
  • Confondre AGENTS.md avec le fichier config.toml au niveau utilisateur.
  • Supposer que les règles dispensent de vérifier les diffs et les tests.

À propos de BetterToken

Si une équipe utilise BetterToken pour unifier le routage des modèles, AGENTS.md reste important. La couche API gère les requêtes de modèles et les enregistrements d’utilisation. AGENTS.md gère le contexte du projet et les règles d’exécution. Utilisez les deux pour réduire la confusion de configuration et le coût de collaboration.

Documentation associée

Références