GitHub – Eine praktische Einführung. Anke Lederer
Bereich ist der »magische Knopf«, um bei anderen Repositories zu unterstützen.
Wir besprechen zunächst Anwendungsfälle für GitHub und werden dann ein eigenes Projekt bzw. Repository aufbauen. Wir ignorieren aber erst einmal, dass es auch noch andere Repositories und Menschen da draußen gibt. Dafür werden wir überwiegend in den mit
Dann schauen wir uns an, was es so alles zu tun und zu beachten gibt, wenn man seine Freundinnen zum eigenen Projekt einlädt (siehe Kapitel 4). Auch hier werden wir in den Bereichen
Später, wenn du etwas erfahrener (und mutiger) bist, werden wir zudem schauen, wo und wie wir andere Repositories unterstützen können (siehe Kapitel 6). Dafür werden wir in den Bereichen
GitHub bietet aber noch viel mehr, z.B. den Marketplace oder den Menüpunkt Explore, der uns helfen kann, unser Projekt bekannter zu machen. Auch das Zusammenspiel mit Git hält weitere Möglichkeiten bereit. Das schauen wir uns aber erst an, wenn du einigermaßen trittsicher bist und wir die Dinge auch wirklich brauchen (das folgt in Kapitel 6, Kapitel 8 und Kapitel 9).
Das GitHub-Logo – Mona Lisa Octocat
Vielleicht ist dir schon das Logo von GitHub aufgefallen (etwa in Tabelle 1-1 in Kapitel 1): eine Katze mit Oktopus-Armen, auch als »Octocat« bekannt mit dem Namen »Mona Lisa«.1 Diese Figur hat im Laufe der Zeit eine solche Beliebtheit unter GitHub-Nutzer*innen erlangt, dass es mittlerweile Folgendes gibt:
Ein Blog2, auf dem alle offiziell erstellten Octocat-Varianten veröffentlicht werden, das sogenannte »Octodex«.
Einen Onlineshop3, um das Maskottchen auf unterschiedlichsten Materialien zu erwerben, unter anderem auf T-Shirts, Stickern und Tassen.
Einen eigenen Twitter-Account4, auf dem Neuigkeiten rund um GitHub veröffentlicht werden.
Und eine Applikation im Webbrowser5, mit der man sich seine eigene Octocat erstellen kann.
Es gibt sogar kleine Comic-Verfilmungen mit Mona als Hauptfigur,6 um beispielsweise Werbung für ein Event oder eine Neuerung zu machen. Auch in manchen Tutorials trifft man auf Mona.
Anwendungsfälle für GitHub (oder: Was will ich da eigentlich?)
Jeder und jede hat unterschiedliche Gründe, sich auf GitHub zu tummeln. Nach meiner Erfahrung gibt es folgende Personengruppen:
1 Die interessierte Anwenderin möchte zu einem bestimmten Projekt ein paar weitergehende Informationen haben, z.B. Installationsanleitungen oder wie man mit einem bekannten Fehler der Software umgeht. Sobald sie einen Fehler melden möchte, wechselt sie in die Rolle der Contributorin (siehe weiter unten).
2 Der Hilfe suchende Programmierer programmiert gerade an etwas Eigenem (auf GitHub veröffentlicht oder auch nicht)7 und sucht für ein spezifisches Problem Inspiration und Hilfe. Oder er sucht nur eine Software, die er herunterladen und nutzen möchte.
3 Der Contributor (englisch contribute = mitwirken, beisteuern) ist Teil eines oder mehrerer (nicht eigener) Projekte (oder möchte es mal werden) und unterstützt mit Code, Dokumentation und/oder möchte einen Fehler melden. Er macht in der Regel Vorschläge für Anpassungen, hat aber keine Rechte, diese auch durchzusetzen.
4 Die Maintainerin dagegen kümmert sich bei Projekten um deren Instandhaltung (englisch maintain = instand halten, GitHub nennt diese Rolle den Collaborator) und verfügt dafür über mehr Rechte als andere. Unter Instandhaltung kann alles Mögliche verstanden werden: die Codebasis aufräumen, Änderungsvorschläge annehmen oder verwerfen, eingehende Fehlermeldungen klassifizieren, das Wiki befüllen oder die entsprechende Website auf dem aktuellen Stand halten.
5 Die Projekteignerin hat vollen Zugriff auf ein oder mehrere Projekte. Das bedeutet, sie kann sowohl inhaltliche Änderungen als auch personelle Besetzungen vornehmen, beispielsweise Maintainer (Collaborator) benennen.
In diesem Kapitel schauen wir uns zunächst alle Aktivitäten genauer an, für die du keinen GitHub-Account benötigst. Konkret sind das die Suche nach Informationen und das Herunterladen von Dateien. Sobald du dich aktiv einbringen möchtest, beispielsweise in Form von Kommentaren oder durch das Einreichen von Änderungsvorschlägen, ist das Anlegen eines Accounts notwendig (siehe auch Tabelle 2-1). Die Konzepte, Begriffe und die typischen Arbeitsschritte, die du dafür benötigst, folgen in den restlichen Kapiteln.
Tabelle 2-1: Übersicht darüber, welche Aktivitäten mit und ohne GitHub-Account durchführbar sind
| Kein Account notwendig | Account notwendig |
| Informationen finden | kommentieren |
| Dateien finden | Wünsche äußern |
| Dateien herunterladen | Fehler melden |
| Änderungsvorschläge einreichen | |
| Projekte veröffentlichen und bearbeiten |
Informationen finden (interessierte Anwenderin)
Eine interessierte Anwenderin möchte sich über ein oder mehrere Projekte informieren. Die Startseite eines Projekts ist der beste Ausgangspunkt dafür. Oben links in der Ecke steht in der Regel der Name des Repositorys und auch der Accountname der Projekteignerin nach dem Muster »Accountname/Repositoryname«. Das Geheimnis, um an mehr Informationen zu kommen, besteht darin, einfach mal runterzuscrollen, und auf einmal zeigt sich eine ganz neue Welt an Informationen (siehe Abbildung 2-3).
Abbildung 2-3: Nach dem Runterscrollen können die ersehnten Informationen zu einem Projekt auftauchen. Eine besondere Bedeutung hat die Datei README.md. Deren Inhalt wird hier nämlich angezeigt.
README.md