pr-message-format.md

Strukturierte PR-Beschreibungen (Überblick, Änderungen, Testinhalt)

Für wen: Teams mit PR-Workflow

So nutzt du es

Inhalt als .windsurfrules ins Projektverzeichnis legen oder in den Windsurf-Einstellungen als globale Rules hinterlegen. Der Editor folgt den Regeln ab der nächsten Anfrage.

Im Detail

Diese Regel definiert, wie Pull-Request-Titel und -Beschreibungen aufgebaut sein sollen: ein Prefix plus englische Kurzzusammenfassung im Titel, dazu eine strukturierte Beschreibung mit Abschnitten wie Überblick, Änderungen und Testinhalt. Sie baut bewusst auf der Commit-Message-Konvention nach Conventional Commits auf, sodass Titel und Commit-Historie denselben Stil teilen. Für Teams, die viele PRs pro Woche mergen, sorgt das für durchsuchbare, konsistente Historie und macht Reviews schneller, weil Reviewer sofort wissen, wo sie Kontext, Diff-Erklärung und Testnachweis finden. Sprache und Pflichtabschnitte lassen sich pro Projekt anpassen, etwa um ein ‘Technical Details’-Feld zu ergänzen.

Praxis-Tipp

Lassen Sie die Regel bei der PR-Erstellung automatisch greifen, etwa mit ‘Erstelle die PR-Beschreibung für diesen Branch’ — der Body wird dann direkt in Überblick, Änderungen und Test gegliedert.

Siehe auch

• commit-message-format.md
• commit-push-pr.md
• test-strategy.md

Lizenz & Quelle

• Lizenz: MIT
• Quelle: github.com/kinopeee/windsurfrules

Lade …