Thursday, September 25, 2014

GitHub für den pragmatischen Einsteiger

Situation

Man hat Quellcode für ein Perl-Skript oder ein CPAN-Modul, der der Öffentlichkeit zur Verfügung steht.

Diesen Quellcode möchte man gerne mit einer Versionsverwaltung verwalten.  Außerdem möchte man anderen Menschen eine einfache Möglichkeit bieten, den Quellcode einzusehen, eventuell Patches zu schreiben, oder eigene Software auf Basis des Quellcodes zu entwickeln.

In diesem Artikel wird Windows vorausgesetzt.


Git und GitHub als Mittel der Wahl

 Als Versionsverwaltung bietet sich Git an. Git ist eine freie Software zur Versionsverwaltung [1]. Im Idealfall verwendet man Git nicht nur, weil es gerade Mode ist, sondern auch aus einem anderen Grund. Davon werden auf Wikipedia auch direkt welche ausgeführt. Die Quellcodes werden dann in einem sog. Repository abgelegt.

Nun soll der Quellcode auch anderen Mensche zur Verfügung stehen. Hier kommt GitHub ins Spiel. GitHub ist eine Plattform zur Verwaltung von Git-Repositorys. Sobald ein Repository auf GitHub angelegt wurde, können dort Quellcodes abgelegt werden. Diese wiederum können durch Dritte einegsehen und genutzt werden, sozusagen als Kollaborationsplattform [2].


Anwendungsfall Patch

Jedes Git-Repository auf GitHub hat eine eigene Webseite. Da kann der Quellcode eingesehen werden.
Ein Repository kann außerdem geforkt werden. Das erstellt eine Kopie des gesamten Repositories für den Nutzer, der klont. Dann kann ein anderer quasi mit dem Quellcode machen was er will, ohne dass die Original-Quellcodes irgend etwas davon mitbekommen.

Möchte man Quellcode in das Repository zurückspielen, so erstellt man einen Pull-Request. Das ist eine Anfrage an das Original-Repository auf GitHub, mit der Bitte die Unterschiede zwischen dem Stand der Quellcodes im Haupt-Repository und den Quellcodes im geforkten Respoitory zu übernehmen.

Das alles muss man nicht von Hand machen, In der Windows-Welt gibt es dafür ein wunderbares Werkzeugt: GitHub für Windows


Genug Theorie, einfach mal machen

  1. GitHub-Account erstellen
  2. GitHub für Windows installieren
  3. Ein Repository aussuchen und forken
  4. GitHub für Windows öffnen und das geforkte Repository auf den loakeln Rechner "klonen":
  5. Änderungen durchführen, z.B. einen Bug beheben
  6. Änderungen synchronisieren. Das bedeutet, dass die Änderungen die auf dem lokalen PC durchgeführt wurden in das geforkte Repository (nicht das Original-Repo) eingefügt werden:
  7. Auf GitHub den "Create Pull Request"-Button drücken
Jetzt erhält der Besitzer des Original-Repositorys eine Nachricht, dass jemand Quellcode zum Einpflegen vorgeschlagen hat.


Quellen / Referenzen

  1. http://de.wikipedia.org/wiki/Git
  2. https://github.com/
  3. https://windows.github.com/

No comments: