Zu einem Projekt beitragen

Erfahre, wie du durch Forking zu einem Projekt beitragen kannst.

In diesem Artikel

Ein Beitrag zu einem Projekt GitHub ist eine wesentliche Fähigkeit für Entwickler und Mitarbeiter, die zusammenarbeiten, um gemeinsame Ziele zu erreichen. Ganz gleich, ob du Fehler behebst, Features hinzufügst oder die Dokumentation verbesserst, eine Beteiligung sorgt für eine strukturierte und effiziente Zusammenarbeit.

Indem Sie dem GitHub Ablauf des Forkens von Repositories, des Erstellens von Branches und des Einreichens von Pull Requests folgen, können Sie Änderungen an einem Projekt vorschlagen und Feedback erhalten, ohne die Arbeit anderer Personen zu beeinträchtigen.

Dieses Handbuch enthält Anweisungen zum Beitragen zu einem Projekt mithilfe der GitHub UI und der Befehlszeile. Weitere Informationen zum Beitragen mit GitHub Desktop finden Sie unter Repositories von GitHub Desktop klonen und per „Fork“ kopieren. Gleiches mit GitHub CLI (Befehlszeilenschnittstelle) finden Sie unter Schnellstart GitHub CLI.

Informationen zum Forking

Wenn du am Projekt einer anderen Person mitwirken möchtest, aber nicht über die Berechtigung zum direkten Vornehmen von Änderungen verfügst, kannst du eine eigene Kopie des Projekts erstellen, Aktualisierungen durchführen und diese dann für die Aufnahme in das Hauptprojekt vorschlagen. Dieser Prozess wird häufig als „Fork und Pull Request“-Workflow bezeichnet.

Wenn du eine eigene Kopie (oder „Fork“) eines Projekts erstellst, kann dies mit dem Erstellen eines neuen Arbeitsbereichs verglichen werden, der über denselben Code verfügt wie das ursprüngliche Projekt. Dies ist nützlich für Open-Source-Projekte oder wenn du keinen Schreibzugriff auf das ursprüngliche Projekt hast.

Nachdem du die Änderungen in deiner Kopie vorgenommen hast, kannst du sie als Pull Request übermitteln. Dies ist eine Möglichkeit, Änderungen am Hauptprojekt vorzuschlagen. Weitere Informationen finden Sie unter Ein Repository forken.

Erstellen einer eigenen Kopie eines Projekts

In diesem Tutorial wird das Spoon-Knife-Projekt verwendet, ein Test-Repository, das auf GitHub gehostet wird und mit dem Sie den Fork- und Pull-Request-Workflow testen können.

  1. Navigieren Sie zu dem Projekt Spoon-Knife unter https://github.com/octocat/Spoon-Knife.

  2. Klicke in der oberen rechten Ecke der Seite auf Fork.

    Screenshot der Hauptseite eines Repositorys. Eine Schaltfläche mit einem Forkensymbol und der Bezeichnung „Fork 59.3k“ ist dunkelorange umrandet.

  3. Wähle unter „Besitzer“ das Dropdownmenü und dann einen Besitzerin für das geforkte Repository aus.

    Hinweis

    Wenn Ihr Benutzername ausgegraut ist, liegt das daran, dass der Fork bereits vorhanden ist. Stattdessen sollten Sie den vorhandenen Fork auf dem neuesten Stand bringen. Weitere Informationen finden Sie unter Einen Fork synchronisieren.

  4. Standardmäßig erhalten Forks den gleichen Namen wie die zugehörigen Upstream-Repositorys. Um deinen Fork noch genauer zu unterscheiden, kannst du optional im Feld „Repositoryname“ einen Namen eingeben.

  5. Gib optional im Feld „Beschreibung“ eine Beschreibung für deinen Fork ein.

  6. Wähle optional Nur Standardbranch kopieren aus.

    Bei vielen Fork-Szenarien, wie z. B. bei Beiträgen zu Open-Source-Projekten, genügt es oft, den Standardbranch zu kopieren. Wenn du diese Option nicht auswählst, werden alle Branches in den neuen Fork kopiert.

  7. Klicke auf Fork erstellen.

Hinweis

Du kannst über die Seite Branches weitere Branches aus dem Upstreamrepository kopieren. Weitere Informationen finden Sie unter Verwalten von Filialen innerhalb Ihres Repositorys.

Einen Fork auf Ihren Computer klonen

Sie haben erfolgreich einen Fork des Spoon-Knife-Repositorys erstellt, aber bisher existiert es nur auf GitHub. Um an dem Projekt arbeiten zu können, musst du es auf deinen Computer klonen.

Sie können Ihren Fork über die Befehlszeile, GitHub CLI oder GitHub Desktop klonen.

  1. Navigieren Sie auf GitHub zu Ihrem Fork des Spoon-Knife-Repositorys.

  2. Klicke oberhalb der Liste der Dateien auf Code.

    Screenshot: Liste der Dateien auf der Startseite eines Repositorys. Die Schaltfläche „Code“ ist orange umrandet.

  3. Kopiere die URL für das Repository.

    • Um das Repository mit HTTPS zu klonen, klicken Sie unter "HTTPS" auf .

    • Wenn du das Repository mithilfe eines SSH-Schlüssels klonen möchtest, einschließlich eines Zertifikats, das von der SSH-Zertifizierungsstelle deiner Organisation ausgestellt wurde, wähle SSH und dann aus.

    • Um ein Repository über die GitHub CLI zu klonen, klicke auf GitHub CLI und dann auf .

      Screenshot des Dropdownmenüs „Code“ Rechts neben der HTTPS-URL für das Repository ist ein Kopiersymbol dunkelorange umrandet.

  4. Öffne unter Mac oder Linux „Terminal“. Öffnen Sie auf Windows Git Bash.

  5. Ändere das aktuelle Arbeitsverzeichnis zum Speicherort, in dem Du das geklonte Verzeichnis haben willst.

  6. Geben Sie ein git clone, und fügen Sie dann die URL ein, die Sie zuvor kopiert haben. Es wird so aussehen, mit Ihrem GitHub Benutzernamen anstelle von YOUR-USERNAME:

    git clone https://HOSTNAME/YOUR-USERNAME/Spoon-Knife

  7. Drücken Sie die EINGABETASTE. Dein lokaler Klon wird erstellt.

    $ git clone https://HOSTNAME/YOUR-USERNAME/Spoon-Knife
> Cloning into `Spoon-Knife`...
> remote: Counting objects: 10, done.
> remote: Compressing objects: 100% (8/8), done.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

Erstellen eines Branches für die Arbeit

Bevor Sie Änderungen am Projekt vornehmen, sollten Sie einen neuen Branch erstellen und ihn auschecken. Indem Sie Änderungen in ihrem eigenen Branch beibehalten, folgen Sie dem GitHub-Flow und stellen sicher, dass es in Zukunft einfacher ist, erneut zu demselben Projekt beizutragen. Weitere Informationen findest du unter GitHub Flow.

git branch BRANCH-NAME
git checkout BRANCH-NAME

Vornehmen und Pushen von Änderungen

Nehmen Sie mit Ihrem bevorzugten Texteditor, wie Visual Studio Code, einige Änderungen am Projekt vor. Sie können z. B. den Text index.html ändern, um Ihren GitHub Benutzernamen hinzuzufügen.

Wenn du bereit bist, die Änderungen zu übermitteln, stage und committe diese. git add . teilt Git mit, dass du alle Änderungen im nächsten Commit einschließen möchtest. git commit erstellt eine Momentaufnahme dieser Änderungen.

git add .
git commit -m "a short description of the change"

Beim Staging und Committing von Dateien teilst du Git dadurch mit, dass eine Momentaufnahme der Änderungen erstellt werden soll. Du kannst weiterhin Änderungen vornehmen und mehr Commit-Momentaufnahmen erstellen.

Deine Änderungen sind derzeit nur lokal vorhanden. Wenn Sie bereit sind, Ihre Änderungen zu GitHub hochzuladen, pushen Sie Ihre Änderungen zum Remote-Repository.

git push

Erstellen eines Pull Request

Das Erstellen eines Pull Requests ist der letztes Schritt beim Erzeugen eines Forks des Projekts einer anderen Person. Wenn du eine vorteilhafte Änderung vorgenommen hast und sie für das ursprüngliche Repository vorschlagen möchtest, erstelle einen Pull Request, der von einem Teamverwalter überprüft werden soll.

Navigieren Sie dazu zu dem Repository, in GitHub dem sich Ihr Projekt befindet. In diesem Beispiel wäre es https://github.com/<your_username>/Spoon-Knife. Es wird ein Banner angezeigt, das angibt, dass dein Branch ein Commit vor octocat:main ist. Klicke auf Mitwirken und dann auf Einen Pull Request öffnen.

GitHub führt Sie zu einer Seite, auf der die Unterschiede zwischen Ihrem Fork und dem Repository octocat/Spoon-Knife angezeigt werden. Klicken Sie auf Pull Request erstellen.

GitHub bringt Sie zu einer Seite, auf der Sie einen Titel und eine Beschreibung Ihrer Änderungen eingeben können. Es ist wichtig, so viele nützliche Informationen und eine Begründung dafür zu liefern, warum du diesen Pull Request überhaupt vornimmst. DerDie Projektbesitzerin muss in der Lage sein, zu entscheiden, ob deine Änderung für die Allgemeinheit so nützlich ist, wie du denkst. Klicke schließlich auf Pull Request erstellen.