TrackerJo/github-pr-attachments

GitHub PR-Anhänge

GitHub selbst ist der zugelassene Host für BuildPurdue PR-Screenshots und Aufnahmen. Diese Fähigkeit verwandelt ignorierte lokale Belege in auf GitHub gehostete PR-Anhänge, ohne Medien in das Repository zu committen.

Verwende diese Fähigkeit, nachdem visual-proof Belege erfasst hat und bevor ein für den Benutzer sichtbarer PR als bereit erklärt wird.

Voraussetzungen

1. Bestätige, dass die Belegdateien existieren und sich unter dem ignorierten artifacts/ befinden.
2. Bestätige, dass die GitHub CLI für dieses Repository authentifiziert ist mit gh auth status.
3. Bestätige, dass die installierte CLI Anhänge unterstützt, indem du die relevante Befehlshilfe überprüfst, z.B. gh pr edit --help, nach --attach.
4. Bestätige, dass der Ziel-PR und der letzte gepushte Commit die sind, die belegt werden.

Leite die Unterstützung von Anhängen nicht aus der Versionszeichenkette von gh ab, wenn der Befehl selbst direkt antworten kann.

Bevorzugter Workflow: Text mit eingebetteten Belegen

Wenn Screenshots Bildunterschriften, Vorher-/Nachher-Tabellen oder eine bestimmte Reihenfolge benötigen, schreibe den PR-Text in eine ignorierte lokale Markdown-Datei und verweise normal auf die lokalen Medienpfade:

## Visueller Beleg

| Vorher | Nachher |
| --- | --- |
| ![Vorher: mobile Veranstaltungsseite](artifacts/event-vorher-phone.png) | ![Nachher: mobile Veranstaltungsseite](artifacts/event-nachher-phone.png) |

[Interaktionsaufnahme](artifacts/event-ablauf.mp4)

Veröffentliche dann den Text und hänge jede referenzierte Mediendatei im selben Befehl an:

gh pr edit <pr> \
  --body-file artifacts/pr-text.md \
  --attach artifacts/event-vorher-phone.png \
  --attach artifacts/event-nachher-phone.png \
  --attach artifacts/event-ablauf.mp4

Die GitHub CLI lädt die Dateien hoch und schreibt übereinstimmende lokale Markdown-Referenzen in die resultierenden von GitHub gehosteten Anhangs-URLs um. Dies wird dem manuellen Einfügen von URLs vorgezogen, da der Text vor dem Hochladen lesbar bleibt und GitHub die endgültigen URLs besitzt.

Nur-Anhängen-Belege

Wenn das Layout keine Rolle spielt, kann ein Bild oder Video angehängt werden, ohne den PR-Text zu ersetzen:

gh pr edit <pr> --attach 'artifacts/nachher.png#Nachher: korrigiertes mobiles Layout'

Wiederhole --attach für mehrere Dateien. Verwende nützlichen Alternativtext für Screenshots. Videos akzeptieren keinen Alternativtext.

Für einen Belegkommentar anstelle des PR-Textes:

gh pr comment <pr> \
  --body-file artifacts/belegkommentar.md \
  --attach artifacts/nachher.png \
  --attach artifacts/interaktion.mp4

Veröffentlichung überprüfen

Betrachte den Befehlsrückgabecode und den PR selbst als separate Prüfungen. GitHub kann einige Dateien erfolgreich hochladen, während ein anderer Anhang fehlschlägt.

Überprüfe nach jedem Upload:

1. Den Exit-Status des Befehls.
2. Lese den PR-Text oder Kommentar von GitHub erneut.
3. Bestätige, dass jeder erforderliche lokale Pfad durch eine von GitHub gehostete URL ersetzt wurde.
4. Bestätige, dass es keine doppelten angehängten Anhänge gibt, die durch einen nicht übereinstimmenden lokalen Markdown-Pfad verursacht wurden.
5. Öffne die veröffentlichten Medien aus dem PR, wenn die aktive Umgebung dies unterstützt.
6. Bestätige, dass die Medien den letzten gepushten Commit belegen und keine Geheimnisse, Token, persönlichen Daten, E-Mail-Adressen, OTPs oder nicht zusammenhängende Benutzerinhalte enthalten.

Wenn ein erforderlicher Anhang fehlt oder veraltet ist, ist der PR nicht bereit.

Harte Einschränkungen

• Commite niemals PR-exklusive Screenshots oder Aufnahmen. Füge kein .github/pr-assets/, public/pr-assets/, Dokumentationsmedien oder ein anderes verfolgtes Asset-Verzeichnis hinzu, nur um Belege verlinkbar zu machen.
• Verwende niemals einen Drittanbieter-Dateihost für BuildPurdue PR-Belege, es sei denn, der Benutzer genehmigt diesen Host explizit für den spezifischen Fall.
• Erfinde, prognostiziere oder konstruiere niemals Anhangs-URLs manuell. Verwende nur URLs, die von GitHub zurückgegeben oder geschrieben wurden.
• Schwäche niemals die Anforderung des visuellen Belegs, weil die Upload-Werkzeuge fehlen. Wenn --attach nicht verfügbar ist, melde diese genaue Voraussetzung und belasse den PR im nicht-bereit-Zustand.
• Veröffentliche niemals sensible Aufnahmen. Schwärze oder nimm vor dem Upload erneut auf.
• Verbleibe mit lokalen Belegen in artifacts/; es ist absichtlich gitignoriert und kann nach der Überprüfung der auf GitHub gehosteten Belege gelöscht werden.

Warum dies existiert

Dies folgt derselben Betriebsregel wie T3 Code: für den Benutzer sichtbare Änderungen tragen überprüfbare visuelle Belege, diese Belege werden auf GitHub hochgeladen, und PR-exklusive Screenshots werden niemals in die Produktgeschichte committet.

Die Anhangs-Funktion der GitHub CLI verhält sich wie Browser-Einfügen/Ablegen: sie lädt das Bild oder Video auf GitHub hoch und fügt die gehostete URL in den PR oder Kommentar ein.

Quellen

• T3 Code-Mitwirkendenregeln: https://github.com/pingdotgg/t3code/blob/main/AGENTS.md
• Dokumentation zu GitHub CLI-Anhängen: https://docs.github.com/en/github-cli/github-cli/attaching-files-with-github-cli
• gh pr edit --attach Handbuch: https://cli.github.com/manual/gh_pr_edit

Quelle

Bearbeite diese Kopie unter .agents/skills/. Der Pre-Commit-Hook spiegelt sie nach .claude/skills/; bearbeite den Spiegel nicht direkt.