Unser Ehrenkodex

Inhaltsverzeichnis

• Präambel
• Kommentare
• Schreibstil
• Git spezifisches
• Protokollierung
• Problemlösungen

Präambel

Im Bewusstsein seiner Verantwortung vor Hr. Kutschenreuter und den Menschen, von dem Willen beseelt, als gleichberechtigtes Glied in einem Informatik P-Seminar der Unterhaltung der Welt zu dienen, hat sich die Gruppe Koramu kraft seiner verfassungsgebenden Gewalt (aka. Ario) diesen Ehrenkodex gegeben. Die Teilnehmer haben in mehr oder weniger freier Selbstbestimmung die Zielsetzung des Teams vollendet. Damit gilt dieser Ehrernkodex für das gesamte Team.

Artikel 1 Kommentare im Code

1. Jeder Teilnehmer ist verpflichtet jede Zeile des von ihm geschriebenen Codes, sofern sinnvoll, so zu kommentieren, dass die anderen Teilnehmer genau nachvollziehen können was diese Zeile bewirkt.
2. Kommentare sind in deutscher Sprache zu verfassen.
3. Der Text eines Kommentars ist mittels eines Tabulators einzurücken.

Artikel 2 Schreibstil

1. weggefallen
2. Methoden in Klassen sind grundsätzlich mittels zweier Zeilenumbrüche voneinander zu trennen.
3. Jene Methoden in Klassen, die einem zusammengehörigen Zweck dienen oder in sonstiger Weise ähnlich sind, werden mit nur einem Zeilenumbruch voneinander getrennt.
4. Geschweifte Klammern beanspruchen nur dann keine eigene Zeile, wenn die Definition des Elementes in der Zeile der Deklaration erfolgen kann.
5. Für sämtliche Bezeichner ist die englische Sprache zu verwenden.
6. script ::= S* (k | c) ript

Artikel 3 Git spezifisches

1. Einer Commit Nachricht ist, sofern vorhanden, die Nummer des bearbeiteten Tickets voranzustellen
2. Commit Nachrichten sind in deutscher Sprache zu verfassen.

Artikel 4 Protokollierung

1. Protokollnachrichten sind in deutscher Sprache zu verfassen.
2. Protokollnachrichten sind möglichst kurz zu halten.
3. Auf die betreffende Funktion ist mittels folgender Syntax Bezug zu nehmen:
   "Klassenname::methodenname():\n\t"
4. Ein Fehlerprotokoll ist genau dann zu schreiben, wenn ein Fehler auftritt.
5. In der Klasse "Game" sind Fehlerausgaben über die Konsole zu erledigen.

Artikel 5 Problemlösungen

1. Selbstmord ist kein Weg Probleme zu lösen. Verstöße werden mit Steinigung geahndet.
2. "If it ain't broke, don't fix it!", wie der Russe sagt.