aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
blob: bc5f574906412df2686b7f6e2385dad381ecf918 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# How to Contribute

[![Build Status](https://travis-ci.org/fsi-tue/skripte.svg?branch=master)](https://travis-ci.org/fsi-tue/skripte)
[![license](https://img.shields.io/github/license/fsi-tue/skripte.svg)](https://github.com/fsi-tue/skripte/blob/master/LICENSE.txt)
![Encoding](https://img.shields.io/badge/Encoding-UTF--8-blue.svg)
[![fsi](https://img.shields.io/badge/Von%20der%20Fachschaft%20genehmigt-ja-blue.svg)](https://www.fsi.uni-tuebingen.de/)

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](/LICENSE.txt)
zustimmen musst. Wir verwenden in diesem Repository eine
[CC BY 4.0](https://creativecommons.org/licenses/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](https://www.fsi.uni-tuebingen.de/) erstellt
worden ist.


### Steps to Contribute

Falls du mit Git noch nicht vertraut bist, kannst du gerne ein Issue in unserem
[Issue Tracker System](https://github.com/fsi-tue/skripte/issues) ö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/skripte geforkt hast.
2. Hol dir eine lokale Kopie deines Forks auf deinen Rechner mit:
   ```
   git clone git@github.com:yourname/skripte.git
   ```
3. Mache deine Änderungen lokal.
4. Committe deine Änderungen und push sie auf deinen Fork.
5. Optional: Am besten prüfst du deine Änderungen ggf. kurz (s. unten).
6. 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](https://travis-ci.org/). Die aktuelle Konfiguration findest du
[hier](https://github.com/fsi-tue/skripte/blob/master/.travis.yml) und eine
Übersicht der letzten Builds [hier](https://travis-ci.org/fsi-tue/skripte/).