Skip to main content

Kurzantwort

AGENTS.md ist eine Projekt-Anweisungsdatei für Codex. Sie informiert Codex über Repository-Struktur, Befehle, Tests, Coding-Stil, Commit-Regeln und Präferenzen für die Zusammenarbeit. Sie ist für stabile Projektregeln und nicht für einmalige Aufgaben gedacht. Lege einmalige Anforderungen in der aktuellen Unterhaltung ab.

Was du aufnehmen solltest

  • Wie Abhängigkeiten installiert, das Projekt gestartet und Tests ausgeführt werden
  • Gängige Validierungsbefehle
  • Coding-Stil und Benennungskonventionen
  • Verzeichnisse, die nicht leichtfertig geändert werden sollten
  • Erforderliche Prüfungen vor dem Abschluss
  • Teampräferenzen für Kommunikation und Ausgabe

Was du nicht aufnehmen solltest

  • API Keys, Tokens, Passwörter oder private Zugangsdaten
  • Temporäre Aufgabenanweisungen
  • Lange Hintergrundgeschichten zum Produkt
  • Allgemeine Prompts ohne Bezug zum Repository
  • Überholte Befehle und Pfade

Vorgeschlagene Struktur

Häufige Fehler

  • AGENTS.md in einen sehr langen universellen Prompt verwandeln.
  • Secrets in die Datei schreiben.
  • Vergessen, sie zu aktualisieren, wenn sich Projektbefehle ändern.
  • AGENTS.md mit config.toml auf Nutzerebene vermischen.
  • Annehmen, dass Regeln die Prüfung von Diffs und Tests überflüssig machen.

Über BetterToken

Wenn ein Team BetterToken für einheitliches Modellrouting verwendet, bleibt AGENTS.md wichtig. Die API-Schicht verarbeitet Modell-Requests und Nutzungsaufzeichnungen. AGENTS.md behandelt Projektkontext und Ausführungsnormen. Verwende beides, um Konfigurationsverwirrung und Zusammenarbeitskosten zu reduzieren.

Verwandte Dokumentation

Referenzen