Anderen helfen, deine Änderungen zu überprüfen

Du kannst Pull Requests verwenden, um klaren Kontext für deine Änderungen bereitzustellen, dein Team auf dem Laufenden zu halten und so die Zusammenarbeit und die Qualität der Rezensionen zu verbessern.

In diesem Artikel

Wenn du einen Pull Request erstellst, bitte dein Team, deine Änderungen zu überprüfen und Feedback zu geben. Dieser Leitfaden bietet Best Practices zum Erstellen von Pull Requests, die leicht zu überprüfen sind und dein Team auf dem Laufenden halten, damit du die Zusammenarbeit und die Qualität der Rezensionen verbessern kannst.

Einfaches Überprüfen deiner Änderungen

Der klare Kontext in deinen Pull Requests hilft Prüfern, schnell zu sehen, was du geändert hast und warum dies wichtig ist. Dadurch wird der Überprüfungsprozess schneller und reibungsloser mit weniger Hin und Her, und dein Team kann so besseres Feedback bereitstellen und sichere Entscheidungen treffen. Weitere Informationen zum Erstellen eines Pull Request findest du unter Erstellen eines Pull Requests.

Schreiben kleiner PRs

Ziel ist es, kleine, fokussierte Pull Requests zu erstellen, die einen einzelnen Zweck erfüllen. Kleinere Pull Requests sind einfacher und schneller zu überprüfen und zusammenzuführen, lassen weniger Platz, um Fehler einzuführen und bieten einen klareren Verlauf der Änderungen.

Überprüfen Ihrer eigenen Pull Requests als Erstes

Überprüfen, erstellen und testen Sie Ihren eigenen Pull Request, bevor Sie ihn übermitteln. Auf diese Weise können Sie Fehler oder Tippfehler erfassen, die Sie möglicherweise verpasst haben, bevor andere mit der Überprüfung beginnen.

Bereitstellen von Kontext und Anleitungen

Schreiben Sie klare Titel und Beschreibungen für Ihre Pull Requests, damit Prüfer schnell verstehen können, was der Pull Request tut. Fügen Sie Folgendes in den Pull Request-Text ein:

  • Der Zweck des Pull Requests
  • Ein Überblick über die Änderungen
  • Links zu zusätzlichem Kontext, z. B. zum Nachverfolgen von Issues oder früheren Unterhaltungen

Um Prüfern zu helfen, geben Sie den benötigten Feedbacktyp weiter. Soll z. B. ein kurzer Blick auf deine Arbeit geworfen werden, oder benötigst du eine ausführlichere Kritik? Du kannst zusätzlich GitHub Copilot verwenden, um eine Zusammenfassung deines Pull Requests zu generieren. Weitere Informationen findest du unter Verwenden von GitHub Copilot zum Generieren von Pull Request-Zusammenfassungen weiter unten in diesem Artikel.

Wenn Ihre Pull Request aus Änderungen an mehreren Dateien besteht, geben Sie Prüfern Anleitungen zur Reihenfolge, in der die Dateien überprüft werden sollen. Empfehlen Sie, wo Sie beginnen und wie Sie mit der Überprüfung fortfahren können.

Dein Team auf dem Laufenden halten

Pull Requests können viel mehr als nur Codeänderungen dokumentieren – sie sind auch eine nützliche Methode, um dein Team und deine Führungskräfte über den Status deiner Arbeit auf dem Laufenden zu halten. Dadurch, dass du deinen Fortschritt in deinen Pull Requests sichtbar machen kannst, sind keine separaten Updates mehr nötig, und jeder ist auf dem neuesten Stand.

Verwenden von GitHub Copilot zum Generieren von Pull Request-Zusammenfassungen

Note

Du benötigst ein GitHub Copilot-Abonnement. Weitere Informationen findest du unter Was ist GitHub Copilot?.

Du kannst Copilot verwenden, um eine Zusammenfassung eines Pull Requests für GitHub zu generieren. Du kannst die Zusammenfassung verwenden, damit Prüfer deine Änderungen nachvollziehen können.

  1. Erstellen Sie auf GitHub einen Pull Request, oder navigieren Sie zu einem vorhandenen Pull Request.

    Note

    GitHub Copilot berücksichtigt keine vorhandenen Inhalte in der Beschreibung des Pull Requests. Daher empfiehlt es sich, mit einer leeren Beschreibung zu beginnen.

  2. Navigieren Sie zu dem Textfeld, in dem Sie die Zusammenfassung des Pull Requests hinzufügen möchten.

    • Wenn Sie einen neuen Pull Request erstellen, verwenden Sie das Feld „Beschreibung hinzufügen“.
    • Wenn Sie einem vorhandenen Pull Request eine Beschreibung hinzufügen, bearbeiten Sie den öffnenden Kommentar.
    • Wenn Sie eine Zusammenfassung als Kommentar hinzufügen, navigieren Sie unten auf der Seite des Pull Requests zum Abschnitt „Kommentar hinzufügen“.

  3. Wählen Sie in der Kopfzeile des Textfelds , und klicken Sie dann auf Zusammenfassung.

    Screenshot des Formulars für einen Pull Request. Ein Copilot-Symbol ist hervorgehoben, und ein Feld mit dem Befehl „Zusammenfassung“ wird angezeigt.

  4. Warten Sie, auf GitHub Copilot, um die Zusammenfassung zu erstellen, und überprüfen Sie die Ergebnisse sorgfältig.

  5. Fügen Sie zusätzlichen Kontext hinzu, der Personen beim Anzeigen Ihres Pull Requests hilft.

  6. Wenn Sie mit der Beschreibung zufrieden sind, klicken Sie auf Pullanforderung erstellen für eine neue Pullanforderung oder auf Kommentar aktualisieren, wenn Sie eine vorhandene Beschreibung bearbeiten.

Verknüpfe deinen Pull Request mit relevanten Issues oder Projektboards, um zu zeigen, wie deine Arbeit in das größere Projekt passt.

  • Füge Schlüsselwörter wie Closes ISSUE-LINK in deine Beschreibung ein, um das Issue automatisch zu verknüpfen und zu schließen, wenn der Pull Request zusammengeführt wird.
  • Verwende Projects, um deine Arbeit nachzuverfolgen und das Projekt aus deinem Pull Request zu verknüpfen, sodass der Fortschritt an einer zentralen Stelle leicht nachverfolgt werden kann. Weitere Informationen findest du unter Informationen zu Projects.

Hervorheben des Status mit Bezeichnungen

Füge deinem Pull Request eine Statusbezeichnung hinzu, um anzuzeigen, ob er bereit zur Überprüfung, blockiert oder in Bearbeitung ist. Dies hilft Prüfern, den Status deiner Arbeit auf einen Blick zu verstehen. Weitere Informationen finden Sie unter Verwalten von Bezeichnungen.