Pull request - dies ist eine Möglichkeit, Änderungen an einem Projekt vorzuschlagen, das im Git-Repository gespeichert ist. Wenn Sie eine pull request erstellen, schlagen Sie Ihre Änderungen vor, damit Entwickler sie überprüfen, besprechen und gegebenenfalls dem Quellcode des Projekts hinzufügen können.
In diesem Tutorial erfahren Sie, wie Sie eine Pull-Anforderung auf beliebten Hosting-Sites wie GitHub und Bitbucket erstellen. Wir werden jeden Schritt beschreiben, angefangen vom Forken des Repositorys über das Klonen auf die lokale Maschine bis hin zum Erstellen der pull request selbst.
Der Prozess zum Erstellen einer pull request kann je nach Hosting etwas unterschiedlich sein, aber die allgemeinen Prinzipien bleiben gleich. Wir werden uns auch einige Best Practices und Tipps ansehen, die Ihnen helfen, eine effektive Pull-Anforderung zu erstellen, die leicht akzeptiert und in das Projekt integriert werden kann.
Die Hauptregel beim Erstellen einer pull request besteht darin, klar und klar zu sein. Je besser Sie Ihre Änderung erklären und warum sie wichtig ist, desto wahrscheinlicher ist es, dass Ihre Pull-Anforderung akzeptiert und in das Projekt aufgenommen wird.
Was ist pull request?
Der Prozess zum Erstellen einer pull request beginnt mit einer Gabel (fork) des Repositorys. Mit der Gabel können Sie eine Kopie des ursprünglichen Repositorys erstellen, mit dem Sie unabhängig arbeiten können. Nach der Gabel kann der Entwickler die notwendigen Änderungen an seiner Gabel vornehmen. Dann kann er mit pull request vorschlagen, dass diese Änderungen in das ursprüngliche Repository aufgenommen werden.
Neben dem Code selbst können Sie mit pull request auch Kommentare und Diskussionen einschließen und nachfolgende Änderungen basierend auf diesen Kommentaren vornehmen. Dies ermöglicht es dem Entwicklungsteam, die vorgeschlagenen Änderungen gemeinsam zu überprüfen und zu besprechen, bevor sie in das Hauptprojekt integriert werden.
Wenn eine pull request erstellt wird, steht sie den anderen Teammitgliedern zur Verfügung. Sie können die vorgenommenen Änderungen überprüfen und ihre Meinung darüber äußern. Anschließend kann ein Code-Review durchgeführt werden, bei dem bestimmte Änderungen am Code vorgenommen werden können und andere möglicherweise abgelehnt werden. Der gesamte Diskussions- und Revisionsprozess findet direkt auf der Pull Request-Seite statt.
Wenn die Änderungen, die an der pull request vorgenommen wurden, die Anforderungen erfüllen und vom Entwicklungsteam genehmigt werden, können sie mit dem Merge-Vorgang in das Hauptprojekt integriert werden. Nach der Integration wird die pull request geschlossen und alle vorgenommenen Änderungen werden Teil des Hauptrepositors.
Daher ist pull request ein Mechanismus, der es Teammitgliedern ermöglicht, gemeinsam an einem Projekt zu arbeiten und Änderungen vorzuschlagen und zu diskutieren, bevor sie sie integrieren. Dies spielt eine wichtige Rolle im Entwicklungsprozess, verbessert die Codequalität und unterstützt die Teamzusammenarbeit.
Definition und Funktionsweise
Das Grundprinzip von pull request besteht darin, dass der Entwickler einen neuen Zweig basierend auf dem Hauptzweig des Projekts erstellt, die erforderlichen Änderungen vornimmt und diese Änderungen dann über pull request an den Hauptzweig vornimmt. Der Projektbesitzer oder der entsprechende Entwickler überprüft die Änderungen, überprüft sie und akzeptiert oder lehnt pull request ab.
Der Prozess zum Erstellen einer pull request umfasst die folgenden Schritte:
- Erstellt einen neuen Zweig basierend auf dem Hauptprojektzweig.
- Änderungen am Projektcode in der erstellten Verzweigung vornehmen.
- Laden Sie die Änderungen in das Remote-Repository hoch.
- Öffnen einer pull request auf der Plattform, auf der das Projekt entwickelt wird (z. B. GitHub).
- Eine Beschreibung der vorgenommenen Änderungen und der Gründe, warum sie vorgenommen wurden.
- Warten auf die Überprüfung und Revision eines pull request durch den Projektbesitzer oder den entsprechenden Entwickler.
- Annahme oder Ablehnung einer Pull-Anforderung.
Die Schritte mit pull request können je nach der Plattform, die für die Projektentwicklung verwendet wird, und den im Entwicklungsteam installierten Prozessen variieren.
Mit pull request können Sie den Code-Review-Prozess vereinfachen, die Zusammenarbeit und Kommunikation zwischen Entwicklern sicherstellen und die Änderungen am Hauptprojektcode überwachen.
Schritte zum Erstellen einer pull request
Führen Sie die folgenden Schritte aus, um mit der Arbeit an einer neuen pull request zu beginnen:
1. Greifen Sie auf das Repository zu
Der erste Schritt besteht darin, auf das Repository zuzugreifen, in dem Sie eine pull request erstellen möchten. Dazu benötigen Sie ein Konto auf der Plattform, auf dem das Repository gespeichert ist, z. B. auf GitHub.
2. Geben Sie das Repository ein
Nachdem Sie auf das Repository zugegriffen haben, müssen Sie es forken. Die Repository-Gabel erstellt eine Kopie des Repositorys auf Ihr Konto, wo Sie Änderungen vornehmen können, ohne den ursprünglichen Code zu stören.
3. Klonen Sie das Repository
Nach dem Forken des Repositorys müssen Sie es auf Ihrem lokalen Computer ablegen. Verwenden Sie dazu den Befehl git clone, indem Sie die URL Ihres Repository-Forks angeben.
4. Erstellen Sie einen neuen Zweig
Es wird empfohlen, einen neuen Zweig zu erstellen, bevor Sie mit der Bearbeitung beginnen. Der Name des Zweiges sollte klar sein und das Wesen der vorgenommenen Änderungen beschreiben.
5. Nehmen Sie die erforderlichen Änderungen vor
Jetzt können Sie die erforderlichen Änderungen am Code vornehmen, kommentieren, Dateien hinzufügen oder löschen, um den Zweck Ihrer pull request zu erfüllen.
6. Mache ein Commit
Wenn die Änderungen abgeschlossen sind, führen Sie ein Commit aus, um diese Änderungen in Ihrem lokalen Zweig zu speichern.
7. Senden Sie die Änderungen an GitHub
Um Änderungen an GitHub zu senden, verwenden Sie den Befehl git push, um Ihren Repository-Fork zu aktualisieren.
8. Erstellen Sie eine pull request
Jetzt können Sie eine pull request erstellen. Gehen Sie zur Repository-Seite auf GitHub und klicken Sie auf die Schaltfläche "New pull request". Geben Sie eine pull request-Beschreibung an, wählen Sie den Zweig aus, an dem Sie Änderungen vornehmen möchten, und senden Sie die Anfrage.
Glückwunsch! Sie haben jetzt eine pull request erstellt und warten darauf, dass Ihr Beitrag überprüft und im Hauptrepository akzeptiert wird.
Schritt 1: Forken Sie das Repository
Der Prozess zum Erstellen einer pull request beginnt damit, das Repository zu forken (zu verzweigen), an dem Sie Änderungen vornehmen möchten. Mit der Gabel können Sie eine Kopie des Repositorys in Ihrem Konto erstellen, wo Sie Änderungen vornehmen können, ohne das ursprüngliche Repository zu beeinflussen.
Um ein Repository zu forken, gehen Sie zur Repository-Seite auf GitHub und klicken Sie oben rechts auf der Seite auf die Schaltfläche "Fork". Nachdem Sie auf die Schaltfläche geklickt haben, erstellt GitHub eine Kopie des Repositorys in Ihrem Konto.
Nach dem Forken des Repositorys werden Sie auf die Seite Ihrer Repository-Kopie weitergeleitet. Jetzt können Sie damit arbeiten, Änderungen vornehmen und eine pull request erstellen, um Ihre Änderungen mit dem ursprünglichen Repository zu kombinieren.
Schritt 2: Einen neuen Zweig erstellen
Um einen neuen Zweig zu erstellen, müssen Sie zur Repository-Seite gehen und auf die Schaltfläche "Branch" oder "Branch" klicken. Danach werden Sie aufgefordert, den Namen des neuen Zweiges anzugeben. Es ist ratsam, einen aussagekräftigen Namen zu wählen, um leicht zu verstehen, was in diesem Zweig geändert wurde.
Nachdem Sie einen neuen Zweig erstellt haben, müssen Sie zu diesem Zweig wechseln. Dazu müssen Sie die Dropdown-Liste der Zweige finden und den gerade erstellten Zweig auswählen.
Jetzt können Sie mit der Arbeit an Ihren Änderungen im Code beginnen. Wenn alle Änderungen fertig sind, können Sie mit dem nächsten Schritt fortfahren - Erstellen Sie eine pull request, um auf Ihre Änderungen hinzuweisen und sie dazu auffordern, sie im Hauptprojekt vorzunehmen.
Schritt 3: Änderungen vornehmen und Commit
Nachdem Sie den Zweig erstellt haben, können Sie mit den Änderungen am Code beginnen. Dazu müssen Sie das Repository auf Ihren lokalen Computer lehnen. Anschließend können Sie die Projektdateien in einem beliebigen Texteditor öffnen und die erforderlichen Änderungen vornehmen.
Nach Abschluss der Änderungen muss jede Änderung im Commit erfasst werden. Ein Commit ist eine Aufzeichnung der vorgenommenen Änderungen, die eine Beschreibung dessen enthält, was getan wurde und von wem.
Sie können verschiedene Tools zum Commit von Änderungen verwenden, z. B. die Git-Befehlszeile oder die grafische Benutzeroberfläche (GUI), die von Ihrem Code-Editor oder Git-Client bereitgestellt wird.
Um ein Commit zu erstellen, müssen Sie eine Commit-Nachricht angeben, die die vorgenommenen Änderungen beschreibt. Zum Beispiel könnte eine Commit-Nachricht wie folgt aussehen: "Ein Fehler mit der Anzeige der Schaltfläche wurde behoben". Es ist wichtig, informative Commit-Nachrichten zu erstellen, damit andere Entwickler leichter verstehen können, welche Änderungen vorgenommen wurden.
Nachdem Sie ein Commit erstellt haben, können Sie es an ein Remote-Repository senden, indem Sie den Befehl git push origin your_in ausführen. Dadurch können Sie die vorgenommenen Änderungen in Ihrem Zweig speichern und sich darauf vorbereiten, eine pull request zu erstellen.
| git add | git commit | git push |
|---|---|---|
| Fügt dem Index Änderungen hinzu | Erstellt ein Commit mit Änderungen | Sendet Commits an das Remote-Repository |
