GitHub und WBA1
Wiki ▸ Git und GitHub ▸ WBA1
Konventionen für die Arbeit am Repository ↑
Um die gemeinsame Arbeit im Repository zu vereinfachen und zu normieren, bitte folgende Konventionen beachten:
Die Ordnernamen dürfen nur aus den Zeichen [a-z0-9] bestehen.
Wenn nötig, sollte eine Trennung mit einem - (Minus) gekennzeichnet sein.
Vorneweg sollte der Präsentationstermin stehen, falls bekannt.
Und zwar in folgendem Format: yyyy-mm-dd z.B. 2013-12-06
Parallelsessions können die selbe Präsentation verwenden. Falls Sie unterschiedliche Präsentationen haben, nutzen Sie bitte ein Suffix im Dateinamen zur Unterscheidung der Präsentationen.
Beispiel: 2013-12-06-html-einstieg-a und 2013-12-06-html-einstieg-b.
Pull Requests ermöglichen Änderungen aus einem anderen Branch in den Original Branch zurück zu übernehmen. Hier gibt es zwei Möglichkeiten dies zu erledigen, einmal über die Webseite von GitHub und einmal über die Shell. Zum dem Pull Request über die Shell ist aber noch anzumerken, das dieser zwar mit Git funktioniert, aber keinen Pull Request auf Github erstellt. Darauf wird aber weiter unten detailierter eingegangen. Die Möglichkeit über Github ist wohl die einfachste der beiden Varianten. Um einen Pull Request auf GitHub zu starten muss man lediglich auf der Seite des Hauptprojekts den unten hervorgehobenen Button anklicken.
(Quelle: Jörn Fiege, Sascha Lemke, WBA1 2012)
Danach besteht die Möglichkeit die Änderungen auszuwählen die an das Hauptprojekt zurückgegeben werden sollen. Sobald dies erledigt ist, kann man noch eine Nachricht angeben die den Inhalt des Pullrequest beschreibt. Sobald das Formular bestätigt ist, erhält Entwickler des Hauptprojekt eine Nachricht und kann die Änderungen die er verwenden möchte dem Projekt hinzufügen.
(Quelle: Jörn Fiege, Sascha Lemke, WBA1 2012)
Umlautprobleme in Dateinamen unter OSX ↑
Nachdem das Repository oder das Wiki ausgecheckt wurde und es Probleme mit Umlauten (in Dateinamen!) gibt führt bitte folgende Befehle im Terminal aus:
# Wechselt in eure lokale Kopie:
cd wba1-2013
# Option für Unicode Dateinamen setzen:
git config core.precomposeunicode true
(Hintergrund Informationen hierzu)
Wie stelle ich meine Präsentation online zur Verfügung? ↑
Damit die Präsentation auch direkt online unter
fh-koeln.github.com/wba1-2013/
verfügbar ist müssen Sie die die public.json erweitert und
anschließend die gesamte Präsentation in den gh-pages Branch zurückmergen.
Am einfachsten können Sie dies über einen Pull Request (siehe oben) machen.
Zum Format der public.json:
"2012-12-06-git-basics/index.html":
{
"title" : "Git Basics",
"authors" : ["Dominik Schilling", "Christoph Jerolimov"]
},
Zuerst kommt der Pfad zur Präsentation. In title wird der Titel der Präsentation
festgehalten und in authors der/die Autor/en definiert.
Achten Sie darauf, dass der letzte Eintrag nicht mit einem Komma beendet wird.