Pull Request auf github erstellen

31. August 2020

Um etwas zu einem Open Source Projekt beizutragen, kann man natürlich nicht munter den Quellcode ändern. Das würde zu maximalen Chaos führen. Plattformen wie github verwalten den Quellcode und erlauben es Mitwirkenden, Änderungen vorzuschlagen. Um dies zu tun müssen sie einen Pull Request auf github erstellen. Der wird dann von den Betreibern / Anbietern des Projektes kontrolliert und akzeptiert oder eben nicht.

Heute habe ich zum ersten Mal einen Pull-Request auf github erstellt. Für die zwei Zeilen war es relativ komplex. Aber ich wollte es dann eben wissen und auch mal gemacht haben ;-). Eine gute Anleitung habe ich hier gefunden. Kurzum ist folgendes zu tun:

Über Github

Es wird ein Account auf der Plattform github benötigt. In dem Projekt, dem etwas beigesteuert werden soll, muss der Button „Fork“ geklickt werden. Dieser spaltet das Projekt sozusagen auf und hinterlegt es ebenfalls im eigenen Account. Nun wird mit dem Fork gearbeitet und das eigentliche Projekt wird von den eigenen Versuchen nicht beeinflusst.

Der Quellcode wird auf dem eigenen PC geändert. Dazu kann das Projekt mit dem Kommando „git“ lokal abgelegt werden. Das Kommando kümmert sich auch darum, Änderungen in die Plattform zurückzuspielen. Hinweise zum hierfür notwendigen Zertifikat habe ich hier aufgeschrieben.

Vorgehen

Zuerst wird ein lokales Projektverzeichnis angelegt und das Projekt dahin gespiegelt:

mkdir <mein Projekt>
cd <mein Projekt>
git clone https://github.com/<mein Benutzername>/<mein Projekt>

Nun muss ein neuer Entwicklungszweig (Branch) angelegt werden. Eine Branch sollte gut beschrieben sein, sagt man. Dazu gibt es diverse Empfehlungen. Am Besten ist vielleicht eine Beschreibung wie „fix-<problem>“ oder so. Wenn es eine Ticketnummer gibt, dann sollte diese erwähnt werden:

git checkout -b <Branch>
git remote add upstream https://github.com/<mein Benutzername>/<mein Projekt>

Ab jetzt kann man munter drauf los programmieren. Läuft alles so wie es soll, wird die Änderung auf die Plattform zurück kopiert. Das passiert mit einem „Commit“, sozusagen einem Paket mit allen Änderungen. Die folgenden Kommandos zeigen die Änderungen, fügen die Dateien zu einem Commit hinzu und senden den Commit:

git status
git add <Dateien>
git commit -S -m "<Beschreibung des Commits, Erklärung der Änderungen>"
git push -u origin <Branch>

Damit ist die Änderung im eigenen Quellcode auf github vorhanden. Dort gibt es unter „Branches“ nun den Button „Compare & Pull Request“. Der öffnet einen Dialog, in dem eine kurze Erklärung zu Änderung abgegeben werden kann. Mit dieser Erklärung werden die Änderungen dann zum ursprünglichen Projekt geschickt. Die Eigentümer dieses Projektes können nun entscheiden, was sie mit dem Pull Request anfangen.

Keine Antworten

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.