CONTRIBUTING.org 2.42 KB
Newer Older
1
2
3
4
5
6
7
8
9
#+TITLE: Contribution Guide
#+AUTHOR: Patric Plattner <patric@patricplattner.de>

* Ich habe eine Frage zu einem Video.
Wenn du ein Video gesehen hast und du eine Frage zum Video hast, dann kannst du
diese gerne als Issue stellen. Eine Video Anleitung, wie du eine Frage stellen
kannst kannst du [[https://www.youtube.com/channel/UCJshmguQzJxDa0r9Q98dbQA][hier]](TODO) sehen.

Wenn du eine Frage stellen moechtest, dann oeffne einfach einen Issue, fuege den
Patric Plattner's avatar
Patric Plattner committed
10
Label "Frage" hinzu, verlinke das relevante Video und stelle deine Frage.
11
12
13
14
15
16
17
18
* TODO Wie kann ich beitragen?
Wenn ihr bei dem Planen bzw. dem Erstellen des Kurses helfen wollt, dann koennt
ihr das gerne machen. Hier ein paar Hinweise, wie ihr Beitragen koennt:

- Ich nutze emacs Org Mode anstatt von Markdown um alle Dokumente in diesem Repo
  zu schreiben. Der Unterschied zu Markdown ist nicht wirklich gross. Hier ist
  ein Beispiel, wie Orgmode Syntax aussieht: [[https://writequit.org/denver-emacs/presentations/files/example.org.html][Beispiel]]
- Wenn ihr Vorschlaege machen wollt, macht dies bitte als einen Issue. Dazu gibt
Patric Plattner's avatar
Patric Plattner committed
19
  es ein paar Labels, mit denen ihr die Issues versehen koennt:
20
21
22
23
24
25
26
27
  + Themen: Wenn ihr einen Vorschlag fuer ein neues Thema oder einen Vorschlag
    fuer neue oder anders aufgeteilte Unterthemen machen wollt.
  + Skript: Wenn ihr einen Vorschlag fuer ein Skript zu einem Thema habt, sei
    dies ein Vorschlag fuer Formulierungen, Konkrete umsetzungen oder einen
    ganzen Vorschlag fuer ein Skript.
  + Korrektur: Wenn ihr einen Fehler irgendeiner Art findet und mich drauf
    aufmerksam machen wollt (Hier bitte falls moeglich explizit Links zu
    relevanten Dateien mit Zeilennummer machen).
28
29
- Sollte euer Vorschlag nicht in eine der Labels passen, dann last ihn einfach
  weg.
30
31
32
33
34
35
- Wenn ihr einen Vorschlag macht, der sich auf bereits existierende Inhalte im
  Repo bezieht, dann verlinkt diese bitte im Issue, ein Ueberblick wie das
  funktioniert, findet ihr [[https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references][hier]] (insb. relevant sind repository file references
  und commit references)
- Solltet ihr groessere Vorschlaege haben, wie z.B. ganze Skripts zu Teilthemen,
  dann koennt ihr dies auch als Merge Request machen.
Patric Plattner's avatar
Patric Plattner committed
36
  + Bitte gebt euren Merge Requests passende Labels.
37
38
39
- Da alle Inhalte auf Freier (Libre) oder Open Source Software basieren sollen,
  sind Anfragen, die die Nutzung von proprietaerer Software erfordern wuerden,
  nicht erwuenscht.