diff options
author | Michael Weiss | 2018-03-21 17:00:44 +0100 |
---|---|---|
committer | Michael Weiss | 2018-03-21 17:19:31 +0100 |
commit | acac8490f38798232f44f86c19d23b0c86468460 (patch) | |
tree | 9113b9e087aed239821a3abbfb786623bd0921ca /CONTRIBUTING.md | |
parent | 2fdf5ccbde04e82d37457a3fd215e88dae7ddc5b (diff) |
Use umlauts, fix some typos, and add an encoding badge
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc99ced..0cae47e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,47 +2,49 @@ [](https://travis-ci.org/fsi-tue/skripte) [](https://github.com/fsi-tue/skripte/blob/master/LICENSE.txt) + [](https://www.fsi.uni-tuebingen.de/) -Wir freuen uns, dass du dir ueberlegst, dich an diesem Repository zu beteiligen. -Zunaechst solltest du wissen, dass du wenn du zu diesem Repository beizutragen -moechtest, unseren +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](https://github.com/fsi-tue/skripte/blob/master/LICENSE) 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 veraendern kannst unter der Bedingung, -dass du entsprechend vermerkst, dass der Inhalt urspruenglich von uns, der -[Fachschaft Informatik Tuebingen](https://www.fsi.uni-tuebingen.de/) erstellt +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) oeffnen. Dazu -musst nur nur auf "New issue" klicken. In dem nun geoeffneten Fenster, kannst du -aehnlich wie in einer E-Mail Betreff und Nachricht eintragen. +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 oeffentlich! Moechtest du uns eine Nachricht -schicken, die nicht fuer die Oeffentlichkeit bestimmt ist, schick uns lieber +**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: +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 Aenderungen lokal -4. Committe deine Aenderungen und push sie auf deinen Fork -5. Erstelle einen neuen Pull Request fuer deine Aenderungen +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. Erstelle einen neuen Pull Request für deine Änderungen. -### Continous Integration +### Continuous Integration -Um zu ueberpruefen, dass alle Verlinkungen zumindest existieren, nutzten wir +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 -Uebersicht der letzten Builts [hier](https://travis-ci.org/fsi-tue/skripte/). +Übersicht der letzten Builds [hier](https://travis-ci.org/fsi-tue/skripte/). |