Schreibe eine PR-Beschreibung, die ein Reviewer nutzen kann
Ziel: Einem Reviewer in zwei Minuten klar machen, worauf er achten soll, und zukünftigen Lesern den Grund für die Änderung verständlich machen.
Sammeln
- Finde den Basis-Branch und führe
git log --oneline <base>..HEADundgit diff --stat <base>...HEADaus, lies dann den Diff. - Suche nach dem Grund: verknüpfte Issue- oder Ticketnummer in Commits oder Branch-Namen, die Anfrage des Benutzers, Kommentare im Diff. Wenn der Grund in keinem davon enthalten ist, frage den Benutzer; erfinde keine Motivation.
- Überprüfe, was getestet wurde: Testdateien im Diff und Befehle, die der Benutzer ausgeführt hat. Wenn keine Tests durchgeführt wurden, sage das deutlich.
- Suche nach einer
.github/pull_request_template.mdoderPULL_REQUEST_TEMPLATE. Wenn eine vorhanden ist, fülle diese aus, anstatt die untenstehende Struktur zu verwenden.
Struktur
<Titel: imperativ, unter 70 Zeichen, benennt die Verhaltensänderung, nicht die Dateien>
## Warum
<Das Problem oder die Anfrage, in 1 bis 3 Sätzen. Verlinke das Issue, falls vorhanden.>
## Was geändert wurde
- <Verhaltensbezogene Aufzählungspunkte, gruppiert nach Bereich, keine Dateiliste.>
## Wie zu reviewen
- Beginne mit <Datei oder Bereich>; der Rest ergibt sich daraus.
- Riskanter Teil: <Der Teil, der am wahrscheinlichsten falsch ist, und warum.>
- Absichtlich nicht geändert: <Alles, was ein Reviewer erwarten könnte und nicht finden wird.>
## Testen
- <Genau ausgeführte Befehle und Ergebnisse.>
- <Manuelle Schritte und was gesehen wurde. „Nicht getestet: ...“ falls zutreffend.>
## Ausrollen / Risiko
<Migrationen, Konfiguration, Feature-Flags, Kompatibilität, Rückrollmethode. „Keine“ nur, wenn es zutrifft.>
Regeln
- Beschreibe, was der Diff tut, nicht, was du dir wünschst, dass er tut. Lies den Diff nach dem Entwurf erneut und lösche jede Behauptung, die er nicht stützt.
- Liste nicht jede Datei auf. Liste dafür Verhaltensänderungen, neue Konfiguration, neue Abhängigkeiten und gelöschten Code auf.
- Keine Füllwörter („Dieser PR zielt darauf ab...“). Keine Emojis, es sei denn, das Repository verwendet sie.
- Screenshots oder Ausgabebeispiele: Gib an, wo eines helfen würde; beschreibe niemals einen Screenshot, den du nicht gesehen hast.
- Gib Titel und Text in einem Codeblock aus, damit sie kopiert werden können. Führe
gh pr createnur aus, wenn du darum gebeten wirst.