Skip to content

Latest commit

 

History

History
14 lines (12 loc) · 2.02 KB

Editor-Guidelines.md

File metadata and controls

14 lines (12 loc) · 2.02 KB

Editor-Guidelines

Es gibt mehrere Sachen, auf welche bitte geachtet werden sollte, wenn man Code beiträgt.
Wenn sie nicht vollständig eingehalten werden, ist es kein Drama, aber es würde den ganzen Prozess ein wenig erschweren.

  1. Der Verfasser einer Lösung ist IMMER derjenige, der an der ersten Version am meisten mitgewirkt hat. Er sollte also von anderen Bearbeitern auf der Titelseite der Lösung nicht mehr verändert werden.
  2. Es sind nur Bilder einzubauen, die entweder selbst gemacht oder generell lizenzfrei sind.
  3. Als Kontaktmailadresse kann eine eigene oder sonst auch meine ([email protected]) angegeben werden.
  4. Eine .tex-Datei und die dazugehörige PDF-Datei sind nach der "Nummer" des beschriebenen Projekts / der beschriebenen Aufgabe zu benennen (siehe bereits hochgeladene Lösungen).
  5. Wenn neue Pakete importiert werden, sollte eine kurze Beschreibung als Kommentar dahinter ergänzt werden, wofür dieses Paket genutzt wird (siehe hier als Beispiel).
  6. Die Bilder sollten immer, wie im Template zu erkennen ist, in dem dort vorliegenden Format benannt und sortiert werden: Für jede Section wird ein neuer Ordner angelegt (durchnummeriert; Leerzeichen im Namen durch Unterstriche ersetzen), die Bilder werden mit Aufgabennummer und Bildnummer in der Aufgabe versehen (z.B. Aufgabe 2, 3. Bild --> 2-3.png)
  7. Es sollte versucht werden, möglichst wenige bis gar keine Fehler oder Warnungen beim Kompilieren zu erzeugen. Gründe und eventuelle Lösungsansätze sind im Internet einfach zu finden.
  8. Wenn bei einer Aufgabe / einem Artikel keine Lösungsansätze nötig sind, trotzdem eine neue Seite erstellen und DIESEN Text/Code ergänzen (nach Regel 3 natürlich auch mit anderer Email-Adresse möglich).