CommunityCodierung & Entwicklunggithub.com

init-agents-md

Erstellt oder aktualisiert eine AGENTS.md für einen bestimmten Bereich auf Basis von Projektevidenz; bei vorhandenen passenden Richtlinien holt es vor dem Schreiben die Zustimmung des Benutzers ein.

Was ist init-agents-md?

Dieses Skill automatisiert die Erstellung und Aktualisierung der AGENTS.md-Datei in einem Repository oder einem bestimmten Verzeichnis. Es analysiert zunächst den Projektkontext, einschließlich Verzeichnisstruktur, Manifest-Dateien, Build-Konfigurationen und relevanter Commits, um eine fundierte und evidenzbasierte Mitwirkungsrichtlinie zu generieren. Dabei werden vorhandene AGENTS.md-Dateien im Zielbereich, in Eltern- und Unterverzeichnissen sowie zugehörige Richtlinien wie CLAUDE.md erkannt und respektiert. Vor dem Schreiben eines neuen oder aktualisierten Dokuments muss der Benutzer explizit zustimmen (z. B. durch Merge, Replace oder Abbruch). Das Skill stellt sicher, dass keine sensiblen Daten ausgelesen oder verändert werden, und validiert das finale Dokument auf strukturelle Korrektheit. Es unterstützt Git- und Nicht-Git-Verzeichnisse und orientiert sich an der Vorlage in `references/agents-md-prompt.md` für Format und empfohlene Abschnitte.

Funktioniert mit✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/hackycy/skills/tree/main/skills/init-agents-md

Installed? Explore more Codierung & Entwicklung skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

AGENTS.md initialisieren

Erstellt eine Mitwirkungsrichtlinie für das Repository-Stammverzeichnis oder ein vorhandenes Verzeichnis. Die alleinige Quelle für das Ausgabeformat und die empfohlenen Abschnitte ist references/agents-md-prompt.md; dieses Skill ist dafür verantwortlich, diese feste Anleitung sicher auf den richtigen Bereich anzuwenden.

Eingabe und Bereich

  • Akzeptiert null oder ein Verzeichnisargument; relative Pfade werden relativ zum aktuellen Arbeitsverzeichnis aufgelöst. Ohne Argument wird das mit git rev-parse --show-toplevel gefundene Git-Stammverzeichnis verwendet.
  • Ein explizites Verzeichnis kann sich außerhalb eines Git-Repositorys befinden; wenn kein Argument angegeben wird und kein Git-Stamm gefunden wird, wird der Benutzer aufgefordert, ein Verzeichnis anzugeben, und der Vorgang wird gestoppt. Der Pfad muss in ein lesbares Verzeichnis aufgelöst werden können; fehlende Pfade, Dateien, nicht lesbare Verzeichnisse oder mehrere Verzeichnisargumente führen zu einem Abbruch.
  • Der Standard-Kandidat für die Ausgabe ist AGENTS.md in diesem Verzeichnis. Es wird immer nur ein Bereich gleichzeitig verarbeitet; es werden keine Verzeichnisse erstellt, keine anderen Dateien geändert und keine Änderungen gestaged, committet oder Branches erstellt.
  • Der Text folgt der Hauptsprache der lokalen Dokumentation; bei unzureichenden Signalen wird Englisch verwendet. Wenn das ausgewählte Verzeichnis nicht das Repository-Stammverzeichnis ist, wird am Anfang ## Scope eingefügt, das das relative Verzeichnis und die geltenden übergeordneten Richtlinien beschreibt; es werden nur lokal neue oder einschränkende Regeln aufgenommen.

Erst erkunden, dann generieren

  1. Vor dem Entwurf werden das Ziel und der erforderliche Projektkontext gelesen: Verzeichnisstruktur, Manifest-/Lockfile, Skripte, Build-/Test-/Lint-Konfiguration, CI, README/CONTRIBUTING sowie bei Verfügbarkeit von Git bis zu 30 relevante Commits. Es werden Monorepo-Paketgrenzen, Paketmanager und die Hauptsprache der lokalen Dokumentation identifiziert.
  2. Es werden alle relevanten AGENTS.md-Dateien gefunden: die Zieldatei, Vorfahrendateien vom Repository-Stamm bis zum übergeordneten Verzeichnis des Ziels sowie verschachtelte Dateien im Unterverzeichnisbaum des Ziels. Bei Nicht-Git-Verzeichnissen wird die Vorfahrenkette überprüft. Die Suche in Unterverzeichnissen beginnt mit direkten Unterverzeichnissen und wird nur erweitert, wenn Manifeste, Paketgrenzen oder vorhandene Richtlinien auf tiefere Ebenen verweisen; .git, Abhängigkeiten/Vendor, Build-/Coverage-Ausgaben, Cache und ignorierte Geheimnisspeicher werden übersprungen.
  3. Die Übereinstimmungen werden als target, ancestor oder nested markiert, und zugehörige Richtlinien wie CLAUDE.md, CONTRIBUTING.md werden als Einschränkungen gelesen. Verschachtelte Richtlinien werden nur gelesen, beibehalten und ggf. verlinkt; sie werden nicht zusammengeführt oder geändert.
  4. Es werden nur die Namen und Metadaten potenzieller Geheimnisdateien überprüft. Es werden niemals Schlüssel, Tokens, Anmeldeinformationen oder .env-Inhalte gelesen oder geschrieben.
  5. Jeder Befehl und jede Konvention muss durch Skripte, Konfigurationen, vorhandene Dateien oder den Verlauf verifizierbar sein. Es wird zwischen beobachteten Repository-Regeln und allgemeinen Standardempfehlungen unterschieden; Abschnitte, Befehle oder Behauptungen ohne Belege werden direkt weggelassen.

Bestätigung passender Richtlinien

Vor der Erstellung eines Entwurfs werden alle Übereinstimmungen, ihre jeweiligen Bereiche und der Kandidaten-Ausgabepfad angezeigt, und es wird auf Gross-/Kleinschreibungskonflikte (z. B. agents.md) geprüft. Dies ist eine harte Hürde:

  • Wenn der Kandidat bereits existiert, wird er gelesen, und der Benutzer wird aufgefordert, zwischen merge, replace oder abort zu wählen.
  • Wenn der Kandidat nicht existiert, aber Vorfahren- oder verschachtelte Richtlinien gefunden werden, wird der Benutzer ausdrücklich aufgefordert, entweder „Neue Richtlinie für diesen Bereich erstellen“ oder „Eine vorhandene benannte Richtlinie aktualisieren“ zu wählen; es dürfen keine untergeordneten Dateien stillschweigend hinzugefügt werden. Wenn eine andere vorhandene Datei ausgewählt wird, wird die Erkundung für das Verzeichnis dieser Datei wiederholt, bevor der Modus ausgewählt wird.
  • Wenn keine Übereinstimmungen vorhanden sind, wird mit dem Entwurf einer neuen Datei für das ursprüngliche Ziel fortgefahren.
  • Wenn die ausgewählte AGENTS.md ein symbolischer Link, ein Verzeichnis, eine spezielle Datei oder eine nicht beschreibbare normale Datei ist, wird der Vorgang mit einer Begründung gestoppt.

Bei unbeantworteten, mehrdeutigen Entscheidungen oder Konflikten mit Richtlinien wie CLAUDE.md bleibt der Arbeitsbereich unverändert.

Feste Anleitung lesen

Vor Beginn des Entwurfs wird references/agents-md-prompt.md vollständig gelesen. Diese Datei ist die autoritative Quelle für Titel, Dokumentationsanforderungen, empfohlene Abschnitte, Wortanzahlziele und Ausdrucksstil; sie wird im Normalbetrieb nicht geändert, und ihr Text wird nicht in dieses Skill kopiert.

Zusammenführen, Vorschau und Schreiben

merge führt auf Basis der Markdown-Überschriften-Semantik zusammen: Vorhandene Fakten und benutzerdefinierte Abschnitte bleiben erhalten, es werden nur fehlende, belegte Inhalte ergänzt. Alle Konflikte bei Befehlen, Pfaden, Prioritäten oder Fakten werden in einer Tabelle aufgelistet, in der der Benutzer für jeden Punkt auswählen kann, ob die vorhandene Version beibehalten, der Beleg übernommen oder benutzerdefinierter Text bereitgestellt werden soll; bei ungelösten Konflikten wird nicht geschrieben. replace wirkt sich nur auf die ausgewählte einzelne Datei aus und erstellt keine automatische Sicherung.

Für neue Dateien wird der vollständige Entwurf angezeigt; für Aktualisierungen wird ein Unified Diff mit Pfad, Bereich, Abschnitten, Wortanzahl, Evidenzlücken und einer Moduszusammenfassung angezeigt. Vor der endgültigen Bestätigung durch den Benutzer werden keine Dateien erstellt oder geändert; bei Änderungswünschen wird zum Entwurf und zur Vorschau zurückgekehrt. Vor dem Schreiben wird das Ziel erneut gelesen; wenn der Inhalt extern geändert wurde, wird der Bestätigungsprozess wiederholt.

Validierung und Abschluss

Vor dem Schreiben wird auf Überschriften, Überschriftenebenen, Bereichsverweise in verschachtelten Richtlinien, referenzierte Pfade/Skripte, Platzhalter, sensible Werte und Markdown-Leerzeichen geprüft; für die Stammrichtlinie wird die Wortanzahl gemäß der festen Anleitung überprüft, für verschachtelte Erweiterungen werden etwa 100–300 Wörter angenommen. Es werden nur mechanische Probleme wie nachgestellte Leerzeichen oder doppelte Leerzeilen automatisch behoben und erneut eine Vorschau angezeigt; semantische oder faktische Probleme werden dem Benutzer zur Entscheidung überlassen. Wenn sich das Ziel in Git befindet, wird git diff --check ausgeführt, andernfalls wird eine gleichwertige Leerraumprüfung durchgeführt; für dieses Skill wird standardmäßig kein vollständiger Build, Test oder Lint ausgeführt.

Abschlussbedingungen: Die bestätigte AGENTS.md existiert unter dem ausgewählten Pfad, hat die statische Prüfung bestanden und stimmt mit der genehmigten Vorschau überein; der Abschlussbericht enthält Modus, Bereich, verifizierte Befehle, Auslassungen/Ungewissheiten und Validierungsergebnisse. Bei Benutzerabbruch oder fehlgeschlagener Validierung wird der Grund gemeldet und das Ziel unverändert gelassen.

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

Verwandte Skills