Entwicklungsrichtlinien


#1

Hallo zusammen!

Ich habe mir die Mühe gemacht und ein paar Regeln aufgeschrieben, die gelten, wenn jemand (mich eingeschlossen) Änderungen am Code vornimmt. Diese Regeln dienen schlicht dazu, dass der Code ein halbwegs einheitliches Aussehen hat und jeder weiß, was sich wo befindet und es nicht wie Kraut und Rüben aussieht.

Ihr findet die Richtlinien hier:
https://github.com/OpenFireSource/AlarmWorkflow/blob/master/Resources/Documentation/CodingGuidelines.de.md

Verständnis der Richtlinien ist Voraussetzung für jegliche Änderung, die am Code durchgeführt wird. Absichtliche Verstöße gegen die Richtlinien können durchaus begründet sein, sind aber im Code zu begründen. Ich nehme es mir heraus, Commits zu kommentieren und den Autor hinzuweisen, oder in den seltensten Fällen Commits zurückzuweisen (absolute Ausnahme, keine Panik).

Nur durch definierte Regeln ist eine gute Zusammenarbeit möglich. So ist es möglich, dass die Codebasis sich schön entfalten kann und nicht über die Jahre unleserlich und letztlich unwartbar wird.

Oracle erklärt es hervorragend hier (unabhängig von Programmiersprachen):
http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-139411.html#16712

Kritik und Anmerkungen zu den Richtlinien bitte hier in den Beitrag schreiben.

Danke für euer Verständnis und auf gute Zusammenarbeit! :slight_smile:

Viele Grüße,
chris