Dieser Styleguide dient unserem Team als Orientierung und Inspirationsquelle, um ein einheitliches Erscheinungsbild und eine klare Kommunikation zu fördern. Er stellt jedoch kein starres Regelwerk dar, sondern eher eine gemeinsame Leitlinie, die uns hilft, in dieselbe Richtung zu arbeiten.
Referenz-Styleguide
Zusätzlich zu einem umfassenden Referenz-Styleguide, auf den wir uns beziehen, haben wir einige spezifische Abschnitte näher beleuchtet und Anpassungen formuliert, die unseren Vorstellungen besser entsprechen. Die Abweichungen sind bewusst gewählt, um uns Raum für Flexibilität zu lassen und den Styleguide auf unsere Anforderungen abzustimmen.
Ausnahmen und Erklärung
Table of Contents
Sie schlagen vor ein Inhaltsverzeichniss zu machen. Prinzipiell ein guter vorschlag und eventuell für ein größeres Projekt, oder unserer gemeinsam gewarteten framework.css, geeingnet, aber für einzelene Projekte müsste man bei jeder Änderung das Inhaltsverzeichnniss prüfen und warten, das steht nicht dafür. Da ist eine sauber Trennung in Sections mit der Suchfunktion besser.
Titling
Diese Sektion ist auch nicht unbedingt falsch, aber wir würden eine andere alternative vorschlagen.
NOVA hat z.B. sowas für Bookmarks, ist kein Standard
HTML
/* !bookmark */
diese Section ist sicher noch auszuarbeiten
Multi-line CSS
Die lesbarkeit ist etwas erhöht, aber mann muss immer mit den einrückungen kämpfen. Vor allem wenn z.B. eine neue und längere Anweisung dazu kommt, müsste man alle anderen wieder nachrücken. Viel Arbeit um sonst und in GIT Porjekten würden Changes entstehen die keine Changes sind.
Folgende Code Konstelaltionen sind unserer Meinung nach nicht sehr anwenderfreundlich:
HTML
.icon--home { background-position: 0 0 ; }
.icon--person { background-position: -16px 0 ; }
.icon--files { background-position: 0 -16px; }
.icon--settings { background-position: -16px -16px; }
Indenting
Diese Art der Einrückungen finden wir nicht sinnvoll das es keiner wirklichen Linie entspricht.
Desweiteren ist es wieder Arbeit wenn sich an der Struktur ändert und das mit den GIT Changes trifft hier auch zu.
Alignment
Siehe Multi-line CSS + Alignment
Meaningful Whitespace
Wir finden nicht dass man mit Enter und Linebreaks und Whitespaces außerhalb der Editorconfig (4 Spaces für Einrückungen) gearbeitet werden sollte.
HTML
Siehe Meaningful Whitespace