Code conventions

[JulianKniephoff]

Jemand könnte sich mal Gedanken zu coding conventions machen. Das heißt entweder einen Style Guide raussuchen oder sich selbst Regeln für alles mögliche überlegen (das ist die schlechtere Variante).

Sachen, die mir beim sichten des ersten (richtigen) PRs aufgefallen sind:

• Einrückung! Spaces? Tabs? Wie viele?
• Klammern sind in Ruby ja nicht immer nötig, wollen wir sie trotzdem immer benutzen? Oder nur in bestimmten Situationen?
• Code conventions betreffen auch HTML und CSS!
• Wie setzen wir die geschweiften Klammern in CSS? Java-Style?

Dieses Issue kann gerne zum Sammeln weiterer Punkte genutzt werden.

Wer sich dieser Aufgabe annimmt, sollte auch mal recherchieren, wie man diese conventions zu einem gewissen Grad erzwingt. Dazu kann man z.B. mal gucken, wie man Konfigurationsdateien für bestimmte Editoren in das Repository tun kann, so dass der Editor sie automatisch findet, wenn man Dateien im Repository bearbeitet. Dazu muss man natürlich erstmal wissen, was für Editoren alle so benutzen, was mich sowieso mal interessieren würde, vielleicht kann mal jemand eine Wiki-Seite erstellen, wo steht, wer was benutzt?

Also, any takers?

Siehe auch #21

[Jack5496]

Einrücken ja, für jede "{" einmal einrücken, also eigentlich genau wie vim oder eclipse das einrücken würde.

[Jack5496]

Einrücken keine Leerzeichen, genau ein TAB
Im VIM ist bei jeden in der config eingestellt, wie viel Platz ein TAB haben soll --> unterschiedlicher Freespace

[Jack5496]

Für jeden der nicht weiß wie man das beim Vim einstellt. Man muss in der vimrc die Zeile 'set expandtab' löschen damit die Tabs normal funktionieren.
'set tabstop' gibt an wie groß ein Tab angezeigt wird. So könnt ihr euch eine gewünschte größe konfigurieren, die aber nur für euch gilt. Jeder hat dann seine eigene Anzeige.

[JulianKniephoff]

Ich bin persönlich gegen Einrückung mit tabs in Rails Projekten, da man sehr viel die Generatoren benutzt und die halt anders eingerückten Code erzeugen. Dieses Mischmasch induziert bei mir Augenbluten.

[JulianKniephoff]

Bitte achtet auch darauf, dass ihr die view templates vernünftig einrückt. Wenn ihr mit <% ... %> einen Block anfangt, wird alles in diesem Block eingerückt. Beispiel:

<% rankings.each do |ranking %>
  <p>
    <%= ranking.user_id %>
  </p>
<% end %>

Achtet auch auf die Leerzeichen hinter dem öffnenden <% und vor dem schließenden %>.

[JulianKniephoff]

Also, ich habe nicht bedacht, dass man bei Rails-Projekten im Grunde auf einen Style festgelegt ist einfach schon dadurch, dass man viel code automatisch generieren lässt. Richtet euch also bitte nach dem Stil, den der generierte Code vorgibt.

Für die Einrückung heißt das insbesondere: Zwei Leerzeichen, keine Tabs.

Ich suche btw. immer noch jemanden, der/die

• die Codebase aufräumt, also insbesondere die Einrückung überall entsprechend anpasst und
• mal recherchiert, wie man insbesondere die Einrückung in den diversen Editoren, die ihr so benutzt, erzwingt und dass dann umsetzt.