CommunityCodierung & Entwicklunggithub.com

PR-Tidy

Vor dem Erstellen oder Aktualisieren eines Pull-Requests, nach einem Refactoring, Umbenennen, Entfernen oder Designwechsel, oder wenn ein Branch aufgeräumt werden soll: Findet und behebt Inkonsistenzen, veraltete Referenzen, fehlende Tests und Dokumentation sowie versehentlich preisgegebene Zugangsdaten.

Was ist PR-Tidy?

PR-Tidy ist ein KI-Fähigkeitsskill, der konsistenzbezogene Überprüfungen eines Branches vor der Erstellung eines Pull-Requests durchführt. Er analysiert die Änderungen (Diff) und sucht nach veralteten Referenzen, Inkonsistenzen in der Dokumentation, fehlenden Tests, Checkern, die nicht ordnungsgemäß in CI/Validatoren eingebunden sind, sowie nach persönlichen Daten oder Zugangsdaten, die versehentlich committet wurden. Der Skill arbeitet auf Basis der Git-Diff-Statistiken und durchsucht das gesamte Repository nach Anomalien. Er ist plattformunabhängig und kann in jeder Entwicklungsumgebung eingesetzt werden, die Git und gängige Code-Überprüfungswerkzeuge verwendet. PR-Tidy ist besonders nützlich für Entwicklerteams, die die Qualität ihrer Codebasis und die Sicherheit ihrer Pull-Requests verbessern möchten, indem er sowohl automatisierte als auch halbautomatische Überprüfungen ermöglicht.

Funktioniert mit✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/chiuhoward/skills/tree/HEAD/pr-tidy

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

Was macht PR-Tidy?

Eine Konsistenzprüfung eines Branches, bevor er zu einem Pull-Request wird. Sie betrachtet, was der Diff geändert hat, und dann alles, was der Diff hätte ändern sollen.

Arbeiten Sie an den Änderungen des Branches selbst. Lassen Sie unberührte Schulden an anderer Stelle im Repository in Ruhe, es sei denn, der Diff macht sie falsch.

0. Umfang

  1. Lesen Sie zuerst die Anweisungen des Repositorys: AGENTS.md, CLAUDE.md, CONTRIBUTING*, README* und alle Dokumente, auf die sie verweisen.

  2. Finden Sie die Basis und den Diff:

    base=$(git merge-base origin/main HEAD)   # oder den Standard-Branch des Repositorys
    git log --oneline "$base"..HEAD
    git diff --stat "$base"...HEAD
    git diff --name-only "$base"...HEAD
    
  3. Überprüfen Sie den Arbeitsbaum (git status). Behalten Sie nicht committete Änderungen bei. Wenn eine von Ihnen vorgenommene Bearbeitung diese überschneidet, stoppen Sie und fragen Sie nach.

  4. Wenn Sie sich auf dem Standard-Branch befinden und nichts zu vergleichen haben, stoppen Sie und sagen Sie es.

1. Klassifizieren Sie den Diff

Sortieren Sie die Änderungen in:

  • Neu: Dateien, Befehle, Funktionen, Optionen, Flags, Konfigurationsschlüssel, Umgebungsvariablen, Skripte, Fähigkeiten.
  • Geändert: Verhalten, Standardwerte, APIs, Signaturen, Regeln und Design: eine Anleitung oder Spezifikation, die jetzt etwas anderes aussagt.
  • Entfernt oder umbenannt: alles, was gelöscht, umbenannt, verschoben oder ersetzt wurde.
  • Infrastruktur: Build, CI, Tests, Werkzeuge.

Daraus erstellen Sie die Oberfläche: jeden Namen, Pfad, jedes Flag, jede Option, jeden Begriff und jede Regel, auf die ein Leser oder eine andere Datei verweisen könnte. Bei Designänderungen listen Sie auch die Schlüsselphrasen der alten Idee auf, nicht nur ihren Namen (eine entfernte „Überprüfung pro Ebene“ kann immer noch als „eine Überprüfung unter jeder Ebene“ beschrieben werden).

2. Veraltete Referenzen

Durchsuchen Sie für jeden entfernten, umbenannten oder neu gestalteten Punkt das gesamte Repository, nicht nur die geänderten Dateien:

git grep -n -w "alter_name"          # Namen, Pfade, Flags
git grep -n -i "Phrase aus dem alten Design"

Suchen Sie in Code, Kommentaren, Tests, Dokumentation, READMEs, Beispielen, Notebooks, Vorlagen, Fähigkeitsdateien, Diagrammen (Mermaid und ASCII) und Konfiguration. Jeder Treffer wird entweder aktualisiert oder mit einem Grund gekennzeichnet.

Erstellen Sie dann eine Abdeckungskarte für jeden neuen oder geänderten Punkt: Wo ist er dokumentiert?

Abdeckungskarte:
  Punkt               Referenz   Anleitung   Beispiel   Erklärung
  --neues-flag        README      -           -          -
  check_levels.py     scripts/    -           -          -

Ein Punkt ohne Abdeckung ist eine Lücke; melden Sie ihn. Schreiben Sie nicht ungefragt ganze neue Dokumentationsseiten.

3. Tests und Dokumentation für neues Verhalten

Für jedes neue oder geänderte Verhalten:

  • Ein Test übt es aus, auf der Ebene, die es besitzt, und seinen Fehlerpfad, wo sich dieser geändert hat. Bevorzugen Sie das vorhandene Testmuster des Repositorys und den engsten Test, der die Regression abfangen würde.
  • Dokumentation beschreibt es dort, wo das alte Verhalten beschrieben wurde: Referenz, Beispiele und jede Anleitung, die den alten Weg gelehrt hat.
  • Melden Sie einen fehlenden Test nur, wenn Sie den konkreten Fehler benennen können, den er abfangen würde. Überspringen Sie Spekulationen und unberührte Abdeckungsschulden.

4. Checker scheitern lautstark

Für jeden neuen oder geänderten Checker, Linter, Validator oder Prüfskript:

  1. Eingebunden. Finden Sie jeden Einstiegspunkt, den das Repository verwendet: .pre-commit-config.yaml, .github/workflows/*, Makefile, justfile, noxfile.py, tox.ini, pyproject.toml oder package.json-Skripte und jeden Validator, der andere Checks aufruft. Bestätigen Sie, dass der Checker von mindestens einem aufgerufen wird. Wenn nicht, binden Sie ihn auf die gleiche Weise wie seine Geschwister ein, oder kennzeichnen Sie ihn.
  2. Scheitert bei schlechter Eingabe. Führen Sie ihn mit einer bewusst defekten Eingabe aus; er muss mit einem Exit-Code ungleich Null beenden.
  3. Scheitert bei nichts. Führen Sie ihn mit leerer oder fehlender Eingabe aus (keine Dateien, keine Übereinstimmungen, nichts geparst); er muss mit einem Exit-Code ungleich Null beenden oder klar sagen, dass er nichts geprüft hat, niemals stillschweigend bestehen.
  4. Hat einen Test, der 2 und 3 abdeckt.

Um dies auch später wahr zu halten, fügen Sie einen Einbindungstest hinzu, z. B. references/test_checkers_wired.py.

5. Zahlen, Versionen und Beispiele

Listen Sie jede Zahl, Version, jedes Datum, jede URL, jedes Zitat, jeden Befehl und jedes Codebeispiel in den Dateien auf, die der Diff berührt hat, oder in den Dokumenten, die sie beschreiben. Für jedes:

  • Nennen Sie seine Quelle: den Code oder Befehl, der es erzeugt, einen Konfigurationswert, einen Datensatz oder ein Papier mit seiner genauen Version (arXiv v3, eine DOI).
  • Überprüfen Sie es erneut: führen Sie den Befehl erneut aus oder lesen Sie die Quelle erneut. Korrigieren Sie es oder kennzeichnen Sie es, wenn Sie es nicht überprüfen können.
  • Behalten Sie seine Bedingung bei: den Datensatz, die Einstellung, die Maschine oder die Zeit, für die eine Zahl gilt („N Punkte in T Stunden auf Maschine M“, nicht „N Punkte“).
  • Fixieren Sie externe Quellen auf eine Version.
  • Zahlen, die sich ständig ändern, werden besser aus Code generiert (z. B. mit cog, überprüft durch cog --check) als von Hand getippt; schlagen Sie es vor.

6. Persönliche Informationen und Zugangsdaten

Überprüfen Sie alles, was der Branch hinzufügt, und jede unversionierte Datei, die hinzugefügt werden soll, bevor sie die Maschine verlässt. Dies ist blockierend: Nichts unten wird durch Weitermachen „behoben".

git diff "$base"...HEAD          # auf dem Branch committed
git diff; git diff --cached      # noch nicht committed
git status --short               # unversionierte Dateien, die möglicherweise hinzugefügt werden

Achten Sie auf:

  • Zugangsdaten: API-Schlüssel, Token, Passwörter, Verbindungsstrings mit Passwörtern, private Schlüssel (-----BEGIN … PRIVATE KEY-----), Cloud- und CI-Geheimnisse, Sitzungscookies.
  • Dateien, die sie enthalten: .env*, *.pem, *.key, id_rsa*, credentials*, secrets*, *.p12, Servicekonto-JSON, .npmrc oder .pypirc mit Token, lokale Einstellungsdateien.
  • Persönliche Informationen: E-Mail-Adressen, Telefonnummern, Privat- oder Postanschriften, echte Namen in Beispielen oder Testdaten, Konto- oder ID-Nummern und identifizierende Daten anderer Personen.
  • Maschinendetails: absolute Home-Pfade (/Users/<name>, /home/<name>, C:\Users\<name>), interne Hostnamen, private IP-Adressen, Benutzernamen in Logs oder Notebook-Ausgaben.
  • Versteckte Stellen: Notebook-Ausgaben und Metadaten, Logs, Screenshots, Testdaten, generierte Berichte, Commit-Nachrichten und die vollständige Historie des Branches, nicht nur seinen endgültigen Zustand.

Führen Sie einen Scanner aus, wenn das Repository einen hat (gitleaks, detect-secrets, pre-commit run --all-files), und lesen Sie den Diff auch selbst; Scanner übersehen persönliche Daten.

Wenn Sie etwas finden:

  • Wiederholen Sie den Wert niemals im Bericht oder in einer Commit-Nachricht. Nennen Sie die Datei, die Zeile und die Art des Elements (AWS-Schlüssel, E-Mail-Adresse).
  • Noch nicht committed: entfernen Sie es, verschieben Sie es in eine ignorierte Datei oder Umgebungsvariable und fügen Sie das Muster zu .gitignore hinzu, wenn es sich um eine Datei handelt.
  • Bereits auf dem Branch committed: stoppen Sie und informieren Sie den Benutzer. Eine Zugangsdaten, die jemals committed wurde, muss widerrufen und ersetzt werden, selbst nachdem die Historie umgeschrieben wurde, da sie möglicherweise bereits kopiert wurde. Schreiben Sie keine gemeinsame Historie ohne den Benutzer um.
  • Persönliche Informationen, die der Benutzer dort absichtlich platziert hat (z. B. seinen eigenen öffentlichen Namen in einer Lizenz): fragen Sie nach, entfernen Sie nicht.

7. Beheben oder kennzeichnen

Bearbeiten Sie minimal, in der eigenen Sprache, Struktur und Terminologie der Datei. Lesen Sie eine Datei vollständig, bevor Sie sie bearbeiten.

Beheben ohne Nachfragen:

  • faktische Korrekturen, die direkt aus dem Diff folgen;
  • veraltete Namen, Pfade, Zählungen, Versionen und Querverweise;
  • Hinzufügen eines neuen Elements zu einer vorhandenen Tabelle oder Liste;
  • Einbinden eines Checkers, wo seine Geschwister das Muster zeigen.

Kennzeichnen oder vor Änderung nachfragen:

  • erzählende, designbezogene oder richtlinienbezogene Texte sowie alles, was der offensichtlichen Absicht des Branches widerspricht;
  • Entfernungen und große Umschreibungen;
  • sicherheitskritische Änderungen;
  • CHANGELOG-Einträge und Versionssprünge;
  • Dateien, die einer anderen Person oder einem anderen Team gehören;
  • neue Tests, die eine Designentscheidung benötigen.

Nie: vorhandene Changelog-Einträge umschreiben oder neu generieren, eine Version stillschweigend erhöhen, generierte Dateien von Hand bearbeiten (verwenden Sie deren Generator) oder Geheimnisse oder echte Zugangsdaten einfügen.

8. Mit Beweisen verifizieren

Keine Behauptung ohne frische Beweise aus dieser Sitzung, nach der letzten relevanten Bearbeitung:

  1. Nennen Sie den Befehl, der die Behauptung beweist.
  2. Führen Sie ihn vollständig aus.
  3. Lesen Sie die gesamte Ausgabe und den Exit-Code.
  4. Geben Sie das Ergebnis mit diesen Beweisen an oder nennen Sie den tatsächlichen Status.

Führen Sie aus, was das Repository bereits hat: seine Tests, Linter, pre-commit run --all-files, Docs-Build und Link-Checks. Ein Werkzeug, das nicht installiert ist, oder ein Dienst, der nicht erreichbar ist, ist eine Verifizierungslücke, die als solche gemeldet wird, niemals ein Bestehen. „Sollte bestehen" und ein „erledigt" eines Agenten sind keine Beweise.

9. Bericht

Umfang: <base>..HEAD, N Dateien, M Commits

Blockierend
- Pfad:Zeile — Art der Zugangsdaten oder persönlichen Informationen (Wert nicht angezeigt) und was benötigt wird

Geändert
- Pfad:Zeile — was geändert wurde und warum der Diff es erforderte

Gekennzeichnet (nicht behoben)
- Pfad:Zeile — das Problem, warum es nicht behoben wurde, der Vorschlag zur Behebung

Abdeckungslücken
- Punkt — wo es dokumentiert oder getestet werden sollte

Verifiziert
- `Befehl` → Ergebnis (Exit-Code)

Nicht verifiziert
- was und warum (fehlendes Werkzeug, externer Dienst, benötigt eine Entscheidung)

Die mechanische Schicht

Die meisten Abschnitte 2–6 erfordern Urteilsvermögen, aber einige können bei jedem Commit ausgeführt werden. Für ein Repository ohne dies bieten Sie die Starter-Konfiguration in references/pre-commit-config.yaml an: Dateihygiene, ruff, codespell, Erkennung privater Schlüssel und Geheimnisse (gitleaks) und pytest mit diff-cover bei Push. lychee-Link-Checks und pfadgesteuerte CI sind besser in einem Workflow als in einem Commit-Hook.

Danksagungen

Angepasst, mit Änderungen, aus MIT-lizenzierten Fähigkeiten: docs-sync und review-test-coverage von Jakub Merta (jMerta/codex-skills); die Diff-Klassifizierung, die Abdeckungskarte und die Fix-oder-Flag-Regeln von document-release von Garry Tan (garrytan/gstack); und die Beweisregel von verification-before-completion von Jesse Vincent (obra/superpowers). Ideen, nicht Text, von Anthropics pr-review-toolkit-Agenten (anthropics/claude-plugins-official). Lizenzen: THIRD_PARTY_NOTICES.md.

Verwandte Skills