Die 10 Gebote (gültig für ALLE Übungsblätter und das Abschlussprojekt)
Lesen Sie sich diese Regeln bitte vor der Bearbeitung und Abgabe des ersten Übungsblattes sorgfältig und vollständig durch. Die Regeln gelten für alle Übungsblätter sowie für das Abschlussprojekt dieser Lehrveranstaltung. Unwissenheit darüber schützt nicht vor späteren Konsequenzen.
1. Erlaubte Konstrukte und Anforderungen Im Laufe der Veranstaltung steigen sowohl die Anforderungen, als auch die Menge der Konstrukte, die Sie für Ihre Programme benutzen dürfen. Als Faustregel gilt: Sie dürfen grundsätzlich alles benutzen, was bereits in der Vorlesung benutzt wurde, aber nichts darüber hinaus. Wenn bei einem Übungsblatt eine Anforderung dazukommt, gilt diese auch für alle zukünftigen Übungsblätter.
2. Abgabe Für die Korrektur maßgeblich ist die letzte Version Ihres Codes in unserem SVN vor dem Abgabetermin. Sie können davor so viele Zwischenversionen (zum Beispiel zu Sicherungszwecken) in unser SVN hochladen, wie Sie möchten. Verspätete Abgaben oder Abgaben per Email werden nicht akzeptiert, fangen Sie also rechtzeitig mit der Bearbeitung an.
3. Makefile Zu der Abgabe jedes Übungsblattes gehört ein Makefile mit den Targets compile, checkstyle, test und clean, wie in Vorlesung 1 erklärt und vorgeführt und im SVN unter public/vorlesung-01/ zur Verfügung gestellt. Unser Continuous Build System (Jenkins) prüft dann automatisch nach jedem Commit, ob diese Targets fehlerfrei durchlaufen. Sie können einen solchen Durchlauf auch manuell anstoßen.
4. Hochladen Laden Sie Ihren Code vollständig in unser SVN hoch. Achten Sie darauf, dass Sie keine unnötigen Dateien hochladen, wie zum Beispiel .o Dateien. Zu manchen Übungsblättern gehören (große) Datensätze. Diese dürfen erst recht nicht mit hochgeladen werden, sonst explodiert das SVN und wenn es ganz schlecht läuft das Universum.
5. Kompilieren Das compile Target muss auf Jenkins grundsätzlich fehlerfrei durchlaufen, sonst wird Ihr Code nicht korrigiert und es gibt 0 Punkte. Grund dafür ist, dass nicht kompilierbarer Code sehr schwer zu durchschauen sein kann und dies unzumutbar viel Arbeit für die Tutor:innen wäre. Fragen Sie bei Problemen bitte rechtzeitg im Forum, siehe Punkt 9. Zwischenversionen (siehe Punkt 2) müssen nicht fehlerfrei durchlaufen.
6. Tests: Schreiben Sie für jede nicht-triviale Funktion einen Unit Test. Jeder Unit Test sollte mindestens ein nicht-triviales Beispiel überprüfen. Wenn es kritische Grenzfälle gibt, die sich durch wenig Aufwand leicht nachprüfen lassen (z.B. Verhalten einer Methode bei leerem Eingabefeld), sollten Sie das ebenfalls tun. Wichtig: wenn ein Test korrekt ist, aber fehlschlägt, weil die Funktion fehlerhaft ist, kriegen Sie trotzdem volle Punktzahl für diesen Test. Sie sollen den Test *nicht* an das fehlerhafte Ergebnis anpassen.
7. Checkstyle Ihr Code muss frei von checkstyle Fehlern sein, sonst gibt es Punktabzug. Das Skript cpplint.py teilt Ihnen mit, falls es Fehler gibt und es ist dann in aller Regel klar, wie diese zu beheben sind. Falls nicht, fragen Sie bitte im Forum.
8. Lesbarkeit Schreiben Sie modularen und verständlichen Code. Wenn ein Teil des Codes für sich alleine umfangreich bzw. komplex genug ist oder mehrfach benötigt wird, gehört er in eine eigene Funktion. Dokumentieren Sie Ihren Code. Jedes Stück Code, dessen Funktionsweise sich nicht unmittelbar durch Lesen des Codes ergibt, sollte erklärt werden. Die Erklärung sollte kurz und aussagekräftig sein. Manchmal ist ein Beispiel nützlicher (und kürzer) als eine abstrakte Erklärung.
9. Forum Wenn Sie ein Problem bei der Implementierung haben, suchen Sie ein paar Minuten (auf Google oder auch auf dem Forum, da wurden sehr viele Fragen schon mal gestellt) nach dem Fehler. Wenn Sie nicht fündig werden, fragen Sie gerne auf dem Forum, da wird Ihnen in der Regel schnell geholfen. Hier ist unsere Anleitung für das richtige Fragen auf dem Forum.
10. Zusammenarbeit Sie können gerne zusammen über die Übungsblätter nachdenken, aber der Code bzw. die Lösungen müssen zu 100% selbst geschrieben werden. Auch das teilweise Übernehmen von Code, egal ob von einer anderen Person, der Musterlösung aus einer vergangenen Vorlesung oder aus dem Internet, gilt als Täuschungsversuch, mit den entsprechenden Konsequenzen. Wir müssen das so deutlich sagen, weil es in der Vergangenheit immer wieder vorgekommen ist. Man lernt nichts, wenn man Code bzw. Lösungen von anderen übernimmt und es ist unfair gegenüber dem Großteil der Teilnehmer:innen, die sich ehrlich Mühe geben. Der zu einem bestimmten Zeitpunkt für Sie zur Verfügung stehende Code im SVN der Veranstaltung (Code aus den bisherigen Vorlesungen + Musterlösung der vergangenen Übungsblätter) '''darf''' verwendet werden. Wenn Sie daraus Codestücke verwenden, weisen Sie aber bitte in der Copyright Notiz Ihres Codes darauf hin und zwar nicht nur allgemein, sondern spezifisch, welcher Code an welcher Stelle verwendet wurde.