Was macht pr-writer?
PR-Titel und -Beschreibungen gemäß Sentry-Konventionen erstellen, aktualisieren und umschreiben. Verwenden Sie dies beim Öffnen eines PR, beim Schreiben oder Aktualisieren eines PR-Titels/-Texts/-Beschreibung, beim Aktualisieren eines bestehenden PR nach wesentlichen Änderungen oder bei der Vorbereitung von Branch-Änderungen für die Überprüfung.
Beschreibung
Dieses Skill hilft dabei, Pull-Request-Titel und -Beschreibungen zu erstellen, aufzufrischen und umzuschreiben, die den Sentry-Konventionen entsprechen. Es erleichtert es, konsistente und informative PRs zu verfassen, die den Teamrichtlinien folgen.
Verwendung
Verwenden Sie dieses Skill in den folgenden Szenarien:
- Öffnen eines neuen PR: Erstellen eines PR-Titels und einer Beschreibung basierend auf den aktuellen Branch-Änderungen.
- Schreiben oder Aktualisieren eines PR-Titels/-Texts/-Beschreibung: Aktualisieren des Titels oder der Beschreibung eines bestehenden PR, um Änderungen besser widerzuspiegeln.
- Auffrischen eines bestehenden PR nach wesentlichen Änderungen: Nach einem Rebase oder nach dem Hinzufügen neuer Commits kann der PR-Titel und die Beschreibung aktualisiert werden, um die neuesten Änderungen widerzuspiegeln.
- Vorbereiten von Branch-Änderungen für die Überprüfung: Vor dem Öffnen eines PR kann das Skill verwendet werden, um die Änderungen zu analysieren und einen geeigneten Titel und eine Beschreibung zu generieren.
Funktionsweise
Das Skill analysiert die aktuellen Branch-Änderungen (z. B. durch git diff gegen den Basis-Branch) und generiert basierend auf diesen Änderungen einen PR-Titel und eine Beschreibung. Es folgt dabei den Sentry-Konventionen, einschließlich:
- Titelformatierung: Verwendung von Emojis (z. B. 🐛 für Bugfix, ✨ für neue Funktion), Prefixes (z. B.
fix:,feat:) und anderen Konventionen. - Beschreibungsstruktur: Aufteilung in Abschnitte wie "Zusammenfassung", "Änderungen", "Überprüfungshinweise" und gegebenenfalls "Checkliste".
- Checkliste: Einbeziehung einer Checkliste mit Elementen wie "Tests bestätigt", "Dokumentation aktualisiert" usw.
Unterstützte Plattformen
Dieses Skill ist für die Verwendung mit KI-Agenten wie Claude Code, Cursor, Codex und anderen konzipiert, die mit Git-Repositories und Pull-Requests interagieren können.
Beispiele
Beispiel 1: Öffnen eines neuen PR
# Angenommen, Sie haben Änderungen in einem Branch und möchten einen PR öffnen
use-skill getsentry/pr-writer "Erstelle einen PR-Titel und eine Beschreibung für die aktuellen Änderungen"
Beispiel 2: Aktualisieren eines bestehenden PR
# Wenn ein bestehender PR (#123) aktualisiert werden muss
use-skill getsentry/pr-writer "Aktualisiere den PR #123 mit den neuesten Änderungen"
Konfiguration
Keine spezifische Konfiguration erforderlich. Das Skill verwendet die Standard-Git-Konfiguration und greift auf das aktuelle Repository und den aktuellen Branch zu.