Hilf mit unsere Seite besser zu machen!

Wir freuen uns, dass du dir überlegst, dich an diesem Repository zu beteiligen. Zunächst solltest du wissen, dass du, wenn du zu diesem Repository beitragen möchtest, unseren Lizenzbestimmungen zustimmen musst. Da wir das Jekyll theme Beautiful Jekyll von Dean Attali verwenden, welches unter der MIT Lizenz lizensiert ist, sind alle Änderungen am Design und der Websiten Struktur ebenfalls unter der MIT Lizenz lizensiert. Alle Textbeiträge (in den .md Markdown Dateien) sind unter der CC BY 4.0 Lizenz lizensiert, was bedeutet, dass du den Inhalt beliebig teilen und verändern kannst unter der Bedingung, dass du entsprechend vermerkst, dass der Inhalt ursprünglich von uns, der Fachschaft Informatik Tübingen erstellt worden ist.

So kannst du uns helfen

Falls du mit Git noch nicht vertraut bist, kannst du gerne ein Issue in unserem Issue Tracking System öffnen. Dazu musst nur nur auf “New issue” klicken. In dem nun geöffneten Fenster, kannst du ähnlich wie in einer E-Mail Betreff und Nachricht eintragen.

Beachte: Jedes issue ist öffentlich! Möchtest du uns eine Nachricht schicken, die nicht für die Öffentlichkeit bestimmt ist, schick uns lieber eine E-Mail.

Falls du bereits mit Git vertraut bist, befolge die folgenden Schritte:

  1. Forke dieses Repository! Im folgenden gehen wir davon aus, dass du das Repository erfolgreich nach https://github.com/yourname/cyberauftritt geforkt hast.
  2. Hol dir eine lokale Kopie deines Forks auf deinen Rechner mit:
    git clone git@github.com:yourname/cyberauftritt.git
    
  3. Installiere alle notwendingen Abhängigkeiten mit:
    cd cyberauftritt
    bundle install
    
  4. Starte einen lokalen Server mit:
    bundle exec jekyll serve
    
  5. Mache deine Änderungen lokal, diese stehen dir nun (mit Außnahme der _config.yml) direkt unter https://127.0.0.1:4000/ zur Verfügung.
  6. Committe deine Änderungen und push sie auf deinen Fork.
  7. Teste deine Änderungen lokal (siehe unten).
  8. Erstelle einen neuen Pull Request für deine Änderungen.

Teste deine Änderungen

Um zu gewährleisten, dass alle Links funktionieren, nutzen wir einen HTML Proofer. Dieser überprüft, ob alle Links noch funktionieren und informiert über tote Links, sofern es welche gibt.

Lokales testen

html-proofer sollte bereits als Abhängigkeit installiert worden sein. Deine lokalen Änderungen kannst du dann testen, indem du folgende Befehle in der Konsole ausführst:

bundle exec jekyll build
bundle exec htmlproofer ./_site

Continous Integration

Um kontinuierlich zu überprüfen, dass alle Verlinkungen zumindest existieren, nutzten wir Travis. Travis ist ein Online Dienst, der die oben genannten Befehle nach jedem push und für jeden Pull Request durchführt. Dies gibt uns die Sicherheit, dass Änderungen nichts kaputt machen. Die aktuelle Konfiguration findest du hier und eine Übersicht der letzten Builds hier.

Falls du das Repository geforkt hast, macht es unter Umständen Sinn, Travis auch für dein Repository zu aktivieren.

Sitzung:
calendar icon Do 26.12.19 18:30
location icon Sand 1 - A104

Nächste Termine:

Ring VL:
calendar icon Mi 27.11.19 16:00
location icon TBA
Eine vollständige Liste aller Veranstaltungen findest du hier