20 KiB

Raw Permalink Blame History Unescape Escape

Einführung in GitHub

Diese Lektion behandelt die Grundlagen von GitHub, einer Plattform zum Hosten und Verwalten von Änderungen an deinem Code.

Sketchnote von Tomomi Imura

Quiz vor der Vorlesung

Einführung

In dieser Lektion behandeln wir:

das Nachverfolgen der Arbeit, die du auf deinem Rechner erledigst
das Arbeiten an Projekten mit anderen
wie man zu Open-Source-Software beiträgt

Voraussetzungen

Bevor du beginnst, überprüfe, ob Git installiert ist. Gib im Terminal ein:
git --version

Falls Git nicht installiert ist, lade Git herunter. Richte anschließend dein lokales Git-Profil im Terminal ein:

git config --global user.name "dein-name"
git config --global user.email "deine-email"

Um zu überprüfen, ob Git bereits konfiguriert ist, kannst du eingeben:
git config --list

Du benötigst außerdem ein GitHub-Konto, einen Code-Editor (wie Visual Studio Code) und musst dein Terminal (oder die Eingabeaufforderung) öffnen.

Gehe zu github.com und erstelle ein Konto, falls du noch keines hast, oder melde dich an und vervollständige dein Profil.

✅ GitHub ist nicht das einzige Code-Repository der Welt; es gibt auch andere, aber GitHub ist das bekannteste.

Vorbereitung

Du benötigst sowohl einen Ordner mit einem Code-Projekt auf deinem lokalen Rechner (Laptop oder PC) als auch ein öffentliches Repository auf GitHub, das als Beispiel dafür dient, wie man zu den Projekten anderer beiträgt.

Code-Verwaltung

Angenommen, du hast lokal einen Ordner mit einem Code-Projekt und möchtest deinen Fortschritt mit Git, dem Versionskontrollsystem, nachverfolgen. Manche Leute vergleichen die Nutzung von Git mit dem Schreiben eines Liebesbriefs an dein zukünftiges Ich. Wenn du deine Commit-Nachrichten Tage, Wochen oder Monate später liest, kannst du dich daran erinnern, warum du eine Entscheidung getroffen hast, oder eine Änderung "rückgängig machen" – vorausgesetzt, du schreibst gute "Commit-Nachrichten".

Aufgabe: Ein Repository erstellen und Code committen

Schau dir das Video an

Repository auf GitHub erstellen. Auf GitHub.com findest du im Reiter "Repositories" oder in der oberen Navigationsleiste die Schaltfläche new repo.
1. Gib deinem Repository (Ordner) einen Namen.
2. Wähle create repository.
Zu deinem Arbeitsordner navigieren. Wechsle im Terminal zu dem Ordner (auch Verzeichnis genannt), den du nachverfolgen möchtest. Gib ein:
```
cd [name of your folder]
```
Ein Git-Repository initialisieren. Gib in deinem Projekt ein:
```
git init
```
Status überprüfen. Um den Status deines Repositories zu überprüfen, gib ein:
```
git status
```
Die Ausgabe könnte etwa so aussehen:
```
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

     modified:   file.txt
     modified:   file2.txt
```
Normalerweise zeigt der Befehl git status Dinge wie Dateien, die bereit sind, im Repository gespeichert zu werden, oder Änderungen, die du möglicherweise beibehalten möchtest.
Alle Dateien zum Nachverfolgen hinzufügen
Dies wird auch als Staging von Dateien oder Hinzufügen von Dateien zum Staging-Bereich bezeichnet.
```
git add .
```
Das git add mit dem Argument . bedeutet, dass alle deine Dateien und Änderungen nachverfolgt werden.
Ausgewählte Dateien zum Nachverfolgen hinzufügen
```
git add [file or folder name]
```
Dies ermöglicht es uns, nur ausgewählte Dateien zum Staging-Bereich hinzuzufügen, wenn wir nicht alle Dateien auf einmal committen möchten.
Alle Dateien aus dem Staging-Bereich entfernen
```
git reset
```
Dieser Befehl hilft uns, alle Dateien auf einmal aus dem Staging-Bereich zu entfernen.
Eine bestimmte Datei aus dem Staging-Bereich entfernen
```
git reset [file or folder name]
```
Dieser Befehl hilft uns, nur eine bestimmte Datei aus dem Staging-Bereich zu entfernen, die wir nicht für den nächsten Commit einbeziehen möchten.
Deine Arbeit speichern. An diesem Punkt hast du die Dateien in einen sogenannten Staging-Bereich hinzugefügt, einen Ort, an dem Git deine Dateien nachverfolgt. Um die Änderung dauerhaft zu machen, musst du die Dateien committen. Dazu erstellst du einen Commit mit dem Befehl git commit. Ein Commit stellt einen Speicherpunkt in der Historie deines Repositories dar. Gib Folgendes ein, um einen Commit zu erstellen:
```
git commit -m "first commit"
```
Dies commitet alle deine Dateien und fügt die Nachricht "first commit" hinzu. Für zukünftige Commit-Nachrichten solltest du eine genauere Beschreibung verwenden, um zu vermitteln, welche Art von Änderung du vorgenommen hast.
Dein lokales Git-Repository mit GitHub verbinden. Ein Git-Repository ist auf deinem Rechner nützlich, aber irgendwann möchtest du ein Backup deiner Dateien an einem anderen Ort haben und auch andere Leute einladen, mit dir an deinem Repository zu arbeiten. Ein großartiger Ort dafür ist GitHub. Wir haben bereits ein Repository auf GitHub erstellt, daher müssen wir nur noch unser lokales Git-Repository mit GitHub verbinden. Der Befehl git remote add erledigt genau das. Gib den folgenden Befehl ein:

Hinweis: Bevor du den Befehl eingibst, gehe zu deiner GitHub-Repository-Seite, um die Repository-URL zu finden. Du wirst sie im folgenden Befehl verwenden. Ersetze https://github.com/username/repository_name.git durch deine GitHub-URL.
```
git remote add origin https://github.com/username/repository_name.git
```
Dies erstellt eine Remote-Verbindung namens "origin", die auf das zuvor erstellte GitHub-Repository zeigt.
Lokale Dateien zu GitHub senden. Bisher hast du eine Verbindung zwischen dem lokalen Repository und dem GitHub-Repository erstellt. Lass uns diese Dateien mit dem folgenden Befehl git push zu GitHub senden:

Hinweis: Dein Branch-Name könnte standardmäßig anders sein als main.
```
git push -u origin main
```
Dies sendet deine Commits im "main"-Branch zu GitHub.
Weitere Änderungen hinzufügen. Wenn du weiterhin Änderungen vornehmen und sie zu GitHub pushen möchtest, musst du nur die folgenden drei Befehle verwenden:
```
git add .
git commit -m "type your commit message here"
git push
```
Tipp: Du möchtest vielleicht auch eine .gitignore-Datei verwenden, um zu verhindern, dass Dateien, die du nicht nachverfolgen möchtest, auf GitHub erscheinen – wie z. B. eine Notizdatei, die du im selben Ordner speicherst, die aber nichts in einem öffentlichen Repository zu suchen hat. Vorlagen für .gitignore-Dateien findest du unter .gitignore templates.

Commit-Nachrichten

Eine großartige Git-Commit-Betreffzeile vervollständigt den folgenden Satz:
Wenn angewendet, wird dieser Commit .

Für den Betreff verwende die Befehlsform im Präsens: "ändern" statt "geändert" oder "ändert".
Wie im Betreff sollte auch im optionalen Textkörper die Befehlsform im Präsens verwendet werden. Der Textkörper sollte die Motivation für die Änderung enthalten und diese mit dem vorherigen Verhalten kontrastieren. Du erklärst das Warum, nicht das Wie.

✅ Nimm dir ein paar Minuten Zeit, um auf GitHub zu stöbern. Kannst du eine wirklich großartige Commit-Nachricht finden? Kannst du eine sehr minimale finden? Welche Informationen hältst du für die wichtigsten und nützlichsten, die in einer Commit-Nachricht vermittelt werden sollten?

Aufgabe: Zusammenarbeit

Der Hauptgrund, Dinge auf GitHub zu stellen, ist die Möglichkeit, mit anderen Entwicklern zusammenzuarbeiten.

Zusammenarbeit an Projekten mit anderen

Schau dir das Video an

In deinem Repository navigiere zu Insights > Community, um zu sehen, wie dein Projekt im Vergleich zu den empfohlenen Community-Standards abschneidet.

Hier sind einige Dinge, die dein GitHub-Repository verbessern können:

Beschreibung. Hast du eine Beschreibung für dein Projekt hinzugefügt?
README. Hast du ein README hinzugefügt? GitHub bietet Anleitungen zum Schreiben eines README.
Beitragsrichtlinien. Hat dein Projekt Beitragsrichtlinien?
Verhaltenskodex. Einen Verhaltenskodex?
Lizenz. Vielleicht am wichtigsten: eine Lizenz?

All diese Ressourcen helfen dabei, neue Teammitglieder einzuarbeiten. Und das sind typischerweise die Dinge, die neue Mitwirkende sich ansehen, bevor sie überhaupt deinen Code betrachten, um herauszufinden, ob dein Projekt der richtige Ort für sie ist, um ihre Zeit zu investieren.

✅ README-Dateien werden oft von beschäftigten Maintainer:innen vernachlässigt, obwohl sie Zeit in Anspruch nehmen, um sie vorzubereiten. Kannst du ein Beispiel für ein besonders aussagekräftiges README finden? Hinweis: Es gibt einige Tools, um gute READMEs zu erstellen, die du ausprobieren könntest.

Aufgabe: Code zusammenführen

Beitragsdokumente helfen Menschen, zum Projekt beizutragen. Sie erklären, welche Arten von Beiträgen du suchst und wie der Prozess funktioniert. Mitwirkende müssen eine Reihe von Schritten durchlaufen, um zu deinem Repository auf GitHub beitragen zu können:

Dein Repository forken. Du wirst wahrscheinlich möchten, dass Leute dein Projekt forken. Forken bedeutet, eine Kopie deines Repositories in ihrem GitHub-Profil zu erstellen.
Klonen. Von dort aus klonen sie das Projekt auf ihren lokalen Rechner.
Einen Branch erstellen. Du wirst sie bitten, einen Branch für ihre Arbeit zu erstellen.
Änderungen auf einen Bereich konzentrieren. Bitte Mitwirkende, ihre Beiträge auf eine Sache gleichzeitig zu konzentrieren – so ist die Wahrscheinlichkeit höher, dass du ihre Arbeit zusammenführen kannst. Stell dir vor, sie schreiben einen Bugfix, fügen ein neues Feature hinzu und aktualisieren mehrere Tests – was, wenn du nur 2 von 3 oder 1 von 3 Änderungen implementieren möchtest oder kannst?

✅ Überlege dir eine Situation, in der Branches besonders wichtig sind, um guten Code zu schreiben und zu veröffentlichen. Welche Anwendungsfälle fallen dir ein?

Hinweis: Sei die Veränderung, die du in der Welt sehen möchtest, und erstelle auch für deine eigene Arbeit Branches. Alle Commits, die du machst, werden auf dem Branch gemacht, auf dem du dich gerade befindest. Verwende git status, um zu sehen, auf welchem Branch du dich befindest.

Gehen wir den Workflow eines Mitwirkenden durch. Angenommen, der Mitwirkende hat das Repository bereits geforkt und geklont, sodass er ein Git-Repository hat, das auf seinem lokalen Rechner bereit ist:

Einen Branch erstellen. Verwende den Befehl git branch, um einen Branch zu erstellen, der die Änderungen enthält, die sie beitragen möchten:
```
git branch [branch-name]
```
Zum Arbeits-Branch wechseln. Wechsle zum angegebenen Branch und aktualisiere das Arbeitsverzeichnis mit git switch:
```
git switch [branch-name]
```
Arbeiten durchführen. An diesem Punkt möchtest du deine Änderungen hinzufügen. Vergiss nicht, Git darüber zu informieren, mit den folgenden Befehlen:
```
git add .
git commit -m "my changes"
```
Stelle sicher, dass du deinem Commit einen guten Namen gibst – für dich selbst und für den Maintainer des Repositories, zu dem du beiträgst.
Deine Arbeit mit dem main-Branch kombinieren. Irgendwann bist du mit deiner Arbeit fertig und möchtest sie mit der des main-Branches kombinieren. Der main-Branch könnte sich inzwischen geändert haben, also stelle sicher, dass du ihn zuerst mit den neuesten Änderungen aktualisierst, indem du die folgenden Befehle verwendest:
```
git switch main
git pull
```
An diesem Punkt möchtest du sicherstellen, dass alle Konflikte, Situationen, in denen Git die Änderungen nicht einfach kombinieren kann, in deinem Arbeits-Branch auftreten. Führe daher die folgenden Befehle aus:
```
git switch [branch_name]
git merge main
```
Dies bringt alle Änderungen von main in deinen Branch, und hoffentlich kannst du einfach weitermachen. Falls nicht, zeigt dir VS Code, wo Git verwirrt ist, und du änderst die betroffenen Dateien, um anzugeben, welcher Inhalt am genauesten ist.
Deine Arbeit zu GitHub senden. Deine Arbeit zu GitHub zu senden bedeutet zwei Dinge: Deinen Branch in dein Repository pushen und dann einen PR (Pull Request) öffnen.
```
git push --set-upstream origin [branch-name]
```
Der obige Befehl erstellt den Branch in deinem geforkten Repository.
Einen PR öffnen. Als Nächstes möchtest du einen PR öffnen. Das machst du, indem du zu deinem geforkten Repository auf GitHub navigierst. Du wirst auf GitHub eine Anzeige sehen, die fragt, ob du einen neuen PR erstellen möchtest. Klicke darauf, und du wirst zu einer Oberfläche weitergeleitet, in der du den Commit-Nachrichtentitel ändern und eine passendere Beschreibung hinzufügen kannst. Nun sieht der Maintainer des Repositories, das du geforkt hast, diesen PR, und Daumen drücken, sie werden ihn schätzen und zusammenführen. Du bist jetzt ein Mitwirkender, yay :)
Aufräumen. Es gilt als gute Praxis, nach einem erfolgreich zusammengeführten PR aufzuräumen. Du möchtest sowohl deinen lokalen Branch als auch den Branch, den du zu GitHub gepusht hast, bereinigen. Lösche ihn zuerst lokal mit dem folgenden Befehl:
```
git branch -d [branch-name]
```
Stelle sicher, dass du als Nächstes zur GitHub-Seite des geforkten Repositories gehst und den Remote-Branch entfernst, den du gerade dorthin gepusht hast. Pull request scheint ein seltsamer Begriff zu sein, da man eigentlich seine Änderungen in das Projekt "pushen" möchte. Aber der Maintainer (Projektbesitzer) oder das Kernteam muss deine Änderungen prüfen, bevor sie mit dem "main"-Branch des Projekts zusammengeführt werden. Du bittest also eigentlich um eine Entscheidungsfindung des Maintainers bezüglich deiner Änderungen.

Ein Pull Request ist der Ort, an dem man die Unterschiede, die auf einem Branch eingeführt wurden, vergleichen und diskutieren kann – mit Reviews, Kommentaren, integrierten Tests und mehr. Ein guter Pull Request folgt ungefähr den gleichen Regeln wie eine Commit-Nachricht. Du kannst einen Verweis auf ein Issue im Issue-Tracker hinzufügen, wenn deine Arbeit beispielsweise ein Problem löst. Dies geschieht mit einem #, gefolgt von der Nummer des Issues. Zum Beispiel #97.

🤞Daumen drücken, dass alle Checks erfolgreich sind und die Projektbesitzer deine Änderungen ins Projekt übernehmen🤞

Aktualisiere deinen aktuellen lokalen Arbeits-Branch mit allen neuen Commits vom entsprechenden Remote-Branch auf GitHub:

git pull

Wie man zu Open Source beiträgt

Zuerst suchen wir ein Repository (oder Repo) auf GitHub, das dich interessiert und zu dem du eine Änderung beitragen möchtest. Du wirst den Inhalt auf deinen Rechner kopieren wollen.

✅ Eine gute Möglichkeit, 'anfängerfreundliche' Repos zu finden, ist die Suche nach dem Tag 'good-first-issue'.

Es gibt mehrere Möglichkeiten, Code zu kopieren. Eine Möglichkeit ist, die Inhalte des Repositories zu "klonen", entweder über HTTPS, SSH oder mit der GitHub CLI (Command Line Interface).

Öffne dein Terminal und klone das Repository wie folgt: git clone https://github.com/ProjectURL

Um am Projekt zu arbeiten, wechsle in den richtigen Ordner: cd ProjectURL

Du kannst das gesamte Projekt auch mit Codespaces, GitHubs eingebettetem Code-Editor / Cloud-Entwicklungsumgebung, oder GitHub Desktop öffnen.

Alternativ kannst du den Code in einem gezippten Ordner herunterladen.

Ein paar weitere interessante Dinge über GitHub

Du kannst jedes öffentliche Repository auf GitHub mit einem Stern markieren, beobachten und/oder "forken". Deine markierten Repositories findest du im Dropdown-Menü oben rechts. Es ist wie ein Lesezeichen, aber für Code.

Projekte haben einen Issue-Tracker, meistens auf GitHub im Tab "Issues", es sei denn, es wird anders angegeben. Dort diskutieren Menschen über Probleme, die das Projekt betreffen. Im Tab "Pull Requests" werden Änderungen, die in Bearbeitung sind, diskutiert und überprüft.

Projekte können auch Diskussionen in Foren, Mailinglisten oder Chat-Kanälen wie Slack, Discord oder IRC haben.

✅ Schau dich in deinem neuen GitHub-Repo um und probiere ein paar Dinge aus, wie das Bearbeiten von Einstellungen, das Hinzufügen von Informationen zu deinem Repo und das Erstellen eines Projekts (z. B. eines Kanban-Boards). Es gibt viel zu entdecken!

🚀 Herausforderung

Arbeite mit einem Freund zusammen an eurem Code. Erstellt ein gemeinsames Projekt, forkt Code, erstellt Branches und führt Änderungen zusammen.

Quiz nach der Vorlesung

Überprüfung & Selbststudium

Lies mehr über das Beitragen zu Open-Source-Software.

Git-Spickzettel.

Üben, üben, üben. GitHub bietet großartige Lernpfade über skills.github.com:

Erste Woche auf GitHub

Dort findest du auch fortgeschrittene Kurse.

Aufgabe

Absolviere den Kurs "Erste Woche auf GitHub".

Haftungsausschluss:
Dieses Dokument wurde mit dem KI-Übersetzungsdienst Co-op Translator übersetzt. Obwohl wir uns um Genauigkeit bemühen, weisen wir darauf hin, dass automatisierte Übersetzungen Fehler oder Ungenauigkeiten enthalten können. Das Originaldokument in seiner ursprünglichen Sprache sollte als maßgebliche Quelle betrachtet werden. Für kritische Informationen wird eine professionelle menschliche Übersetzung empfohlen. Wir haften nicht für Missverständnisse oder Fehlinterpretationen, die sich aus der Nutzung dieser Übersetzung ergeben.

20 KiB Raw Permalink Blame History Unescape Escape