How to Contribute

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. Wir verwenden in diesem Repository eine CC BY 4.0 Lizenz, 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.

Steps to Contribute

Falls du mit Git noch nicht vertraut bist, kannst du gerne ein Issue in unserem Issue Tracker 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:

Forke dieses Repository! Im folgenden gehen wir davon aus, dass du das Repository erfolgreich nach https://github.com/yourname/skripte geforkt hast.
Hol dir eine lokale Kopie deines Forks auf deinen Rechner mit:
```
git clone git@github.com:yourname/skripte.git
```
Mache deine Änderungen lokal.
Committe deine Änderungen und push sie auf deinen Fork.
Optional: Am besten prüfst du deine Änderungen ggf. kurz (s. unten).
Erstelle einen neuen Pull Request für deine Änderungen.

Testing your changes

Je nach Komplexität deiner Änderung kannst du dir diesen Schritt auch sparen. Bei normalen Änderungen sollte es reichen, wenn du dir kurz über GitHub die Vorschau anzeigen lässt (du kannst den GitHub flavored Markdown code natürlich auch lokal, z. B. mit Pandoc rendern). Bei komplexeren Änderungen bietet es sich an die GitHub Pages auf dem eigenen Fork zu aktivieren: Settings -> GitHub Pages -> Source -> master branch -> Save. Nach ein paar Sekunden kannst du deine Seite über https://yourname.github.io/skripte/ aufrufen. Alternativ kannst du Jekyll auch lokal ausführen (advanced).

Continuous Integration

Um zu überprüfen, dass alle Verlinkungen zumindest existieren, nutzten wir Travis. Die aktuelle Konfiguration findest du hier und eine Übersicht der letzten Builds hier.