Communitygithub.com

Gary06868/repo-proof

Mach deine README wahrheitsgemäß mit evidenzbasierten Berichten aus einem frischen Klon.

Was ist repo-proof?

RepoProof ist eine Fähigkeit für KI-Agenten (wie Claude Code, Cursor, Codex), die es ermöglicht, die README und Release-Anweisungen eines Repositories aus der Perspektive eines neuen Benutzers zu überprüfen. Es behandelt die README als vertragliche Zusage und prüft, ob Installations-, Ausführungs-, Test- und Demoschritte tatsächlich aus einem frischen Klon heraus funktionieren. Die Fähigkeit umfasst einen Audit-Modus (standardmäßig sicher, ohne Ausführung von Repository-Code), einen Prove-Modus (mit expliziter Benutzererlaubnis) und einen Fix-Modus (Vorschlag minimaler Änderungen). RepoProof ist besonders nützlich für Repository-Betreuer, die sicherstellen möchten, dass ihre Anleitungen korrekt und überprüfbar sind, und unterstützt GitHub Actions für kontinuierliche Wahrheitsverifikation. Es generiert strukturierte Berichte und Klassifizierungen für Fehler in READMEs, Skripten, Konfigurationen und Paketen.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add Gary06868/repo-proof

In Ihrer bevorzugten KI fragen

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

Dokumentation


name: repo-proof description: Verwende diese Fähigkeit, wenn ein Benutzer nachweisen muss, dass die README eines Repositorys oder Release-Anweisungen aus einem frischen Klon funktionieren: Überprüfe Installations-/Ausführungs-/Test-/Demo-Schritte, erstelle Reinraumevidenzen, klassifiziere README-/Skript-/Konfigurations-/Paketfehler, generiere minimale Korrekturen oder füge eine GitHub Action für die Wahrheitsverifikation der README hinzu. Nicht verwenden für gewöhnliches README-Schreiben, allgemeine Code-Reviews, breite QA-Checklisten oder Aufgaben, die keinen repository-basierten Nachweis aus einem frischen Klon erfordern.

RepoProof

Beweise das Repository aus der Sicht eines neuen Benutzers. Behandle die README als Vertrag, nicht als Vorschlag.

Standard-Workflow

  1. Führe node scripts/repoproof.mjs audit . --output repoproof-output aus.
  2. Lese repoproof-output/repoproof-report.json, bevor du Schlüsse ziehst.
  3. Wenn der Benutzer die Ausführung explizit erlaubt, führe node scripts/repoproof.mjs prove . --allow-exec --output repoproof-output aus.
  4. Wenn Korrekturen angefordert werden, führe node scripts/repoproof.mjs fix . --dry-run --output repoproof-output aus und überprüfe repoproof-fixes.patch.
  5. Berichte nur das, was die Evidenz stützt. Markiere unbewiesene Behauptungen als unbewiesen.

Sicherheitsregeln

  • Der Audit-Modus ist die Voreinstellung und darf keinen Repository-Code ausführen.
  • Der Prove-Modus erfordert explizite Benutzerfreigabe mit --allow-exec oder einem CI-Runner.
  • Niemals veröffentlichen, bereitstellen, pushen, mergen oder Benutzergeheimnisse lesen.
  • Niemals eine starke Sandbox-Umgebung behaupten ohne echten Container, VM oder Betriebssystem-Sandbox.
  • Verwende deterministische Skripte zur Evidenzerfassung und -bearbeitung.

Referenzen

  • Lese references/workflow.md für den vollständigen Audit-/Prove-/Fix-Workflow.
  • Lese references/safety-model.md, bevor du Repository-Code ausführst.
  • Lese references/extraction-rules.md, wenn die Extraktion von README-Schritten mehrdeutig ist.
  • Lese references/fix-policy.md, bevor du Änderungen vorschlägst.
  • Lese references/evidence-schema.md, wenn du Berichte interpretierst.
  • Lese references/github-action.md, bevor du CI hinzufügst.
  • Lese references/platform-notes.md für Unterschiede zwischen Windows, macOS und Linux.

Verwandte Skills