ProofShot — Visueller Verifikations-Workflow
Wann verwenden
Verwende ProofShot nach:
- Erstellen einer neuen UI-Funktion oder Seite
- Ändern vorhandener UI-Komponenten
- Beheben eines visuellen Fehlers
- Jeder Änderung, die das betrifft, was der Benutzer sieht
Der Workflow (immer diese 3 Schritte befolgen)
Schritt 1: Sitzung starten
proofshot start --description "was du verifizieren wirst"
Dies startet den Dev-Server, öffnet einen Headless-Browser und beginnt mit der Aufzeichnung. Die Beschreibung erscheint im Proof-Bericht für den Menschen.
Schritt 2: Browser steuern und testen
Verwende proofshot exec, um zu navigieren, zu interagieren und zu verifizieren:
proofshot exec snapshot -i # Interaktive Elemente anzeigen
proofshot exec open http://localhost:PORT/page # Zu einer Seite navigieren
proofshot exec click @e3 # Einen Button klicken
proofshot exec fill @e2 "[email protected]" # Ein Formularfeld ausfüllen
proofshot exec screenshot schritt-NAME.png # Wichtige Momente erfassen
Mache Screenshots zu wichtigen Momenten – diese werden zum visuellen Beweis. Überprüfe, was du erwartest zu sehen, indem du die Snapshot-Ausgabe liest.
Schritt 3: Anhalten und den Proof bündeln
proofshot stop
Dies stoppt die Aufzeichnung, sammelt Konsolen- + Serverfehler und generiert eine SUMMARY.md mit Video, Screenshots und Fehlerbericht.
Schritt 4 (optional): Proof im PR veröffentlichen
proofshot pr # PR automatisch aus aktuellem Branch erkennen
proofshot pr 42 # Bestimmte PR-Nummer angeben
Dies lädt Screenshots und Video auf GitHub hoch und postet einen formatierten Kommentar im PR. Standardmäßig verwendet es die offizielle GitHub Contents API auf einem proofshot-artifacts-Branch. Verwende --upload-provider github-web-attachments, wenn du speziell GitHub-Anhang-URLs verwenden möchtest.
Tipps
- Verwende immer eine aussagekräftige --description, damit der Mensch weiß, was getestet wurde
- Mache Screenshots VOR und NACH wichtigen Aktionen (z. B. vor Formularabsendung, nach Weiterleitung)
- Wenn du während der Verifikation Fehler findest, behebe sie und führe den Workflow erneut aus
- Verwende
proofshot prnach dem Stoppen, um den Proof direkt am Pull Request anzuhängen