In diesem Ratgeber
Ein guter Pull Request erklärt, warum du die Änderung vorgenommen hast, was du geändert hast und wie sich das Ergebnis überprüfen lässt. Stell dir vor, dass die Serverantwort beim Checkout ausbleibt und der Client dieselbe Anfrage erneut sendet, wodurch eine zweite Bestellung entstehen kann. Du könntest den PR Prevent duplicate orders when checkout retries nennen. Der Titel sagt, was die Änderung bewirkt und in welcher Situation das Problem auftritt.
Gib Kontext für das Review
Beschreibe in einem Satz, welches Verhalten der Anlass für den PR war. Erkläre dann deine technische Entscheidung so, dass sie auch jemand versteht, der den Diff gerade zum ersten Mal öffnet. In diesem Beispiel unterstützt der Server bereits Idempotenzschlüssel, und der Client verwendet jetzt denselben Schlüssel, wenn er die Anfrage für denselben Checkout-Versuch erneut sendet. So erkennt der Server die wiederholte Anfrage und gibt das ursprüngliche Ergebnis zurück. Wie eine API solche Schlüssel einsetzt, zeigt die Stripe-Dokumentation zu idempotenten Anfragen.
Verlinke ein relevantes Issue, wenn das Review Hintergrundwissen erfordert. Das GitHub-Blog empfiehlt ebenfalls, den Zweck des PRs und die gewünschte Art von Feedback ausdrücklich zu nennen. GitHub-Blog
Eine vollständige PR-Beschreibung auf Englisch
Context. If the server creates an order but the response times out, the checkout client may retry the request.
Change. This PR reuses the same idempotency key when the client retries a checkout attempt.
The server then returns the original order.
Testing. I added a regression test that simulates a timeout after the server creates the order.
The retry returns the same order ID.
Review focus. Could you check how we handle a retry after the checkout page reloads?
Mit I added a regression test sagst du, welchen Test du zusammen mit der Änderung hinzugefügt hast. Wenn du auch manuell getestet hast, nenne die Umgebung und beschreibe, was du beobachtet hast. Mit I verified in staging that the retry returned the original order ID nennst du beispielsweise ein Ergebnis, das sich im Review nachvollziehen lässt. Wenn ein Szenario noch nicht geprüft ist, sag, was aussteht und wer sich darum kümmert.
Bitte um ein Code-Review mit einer konkreten Frage
Could you review this PR? ist eine allgemeine Bitte um ein Review. Sag dazu, worauf jemand besonders achten soll, etwa mit Could you check whether the retry flow handles a page reload? Wenn eine Frist feststeht, nenne die Uhrzeit, zum Beispiel mit by 16:00 UTC.
Teile in Slack oder im Teamchat den Link und fasse die Änderung in einem Satz zusammen. So kann dein Gegenüber besser einschätzen, wann das Review dran ist. So bittet thoughtbot in Slack um PR-Reviews
Übe mit deinem nächsten PR
Wähle eine kleine Änderung aus, die du diese Woche vorgenommen hast. Beginne den Titel mit Fix, Add oder Prevent und beschreibe, welches Verhalten sich ändert. Schreibe je einen Satz zum Hintergrund und zum Test und stelle eine Frage zu einer konkreten Stelle im Diff.
Lies die Beschreibung laut vor. Sie kann dir auch helfen, deinen PR im Daily auf Englisch zu erklären.