Code Standards

Code

Wir gebrauchen aussagekräftige Variablennamen, welche uns einen Hinweis auf ihren Verwendungszweck geben

item_to_sell = Item.new()
buyer = params[:buyer]

Wir benutzen Einrückungen um unseren Code lesbar zu gestalten

def bli_bla_blup
  if (true)
    #do things
  else
    #you won't do that anyway..
end

Wir schreiben invariante Variablen in Grossbuchstaben

PI = 3.14

#Testen Wir testen unsere Methoden (bis auf getters und setters) jeweils dann wenn wir sie schreiben. Ob vorher oder nachher bleibt jedem selbst überlassen. Bei einem push muss jedoch der Test vorhanden sein, auch wenn die Methode noch nicht fertig ist.

Wir gebrauchen invarianten und preconditions

Wir benutzen Geeknamen für die Variablen die im Test gebraucht werden ;). (Okay, ich gebs zu diesen Punkt muss man nicht so ernst nehmen)

larry_wall = User.new() #Erfinder von Perl
yukihiro_matsumoto = User.new() #Erfinder von Ruby
linus_torvalds = User.new() #Erfinder von Linux

Dokumentation

Wir dokumentieren jede Methode, die wir schreiben

Wir dokumentieren dabei die Argumente und den zu erwarteten Output

Git

Wir pushen möglichst nach jedem commit

Wir pushen NIE einen nicht gelösten Mergekonflikt. Falls man sich wirklich vertan hat ist immer noch folgendes möglich:

1. Geänderte und noch nicht commitete Dateien in einen anderen Ordner (ausserhalb von Git) speichern

2. Zurücksetzen auf letzen funktionierenden commit

   reset --hard _letzerFunktionierenderCommit_

3. Erneut pullen

4. Veränderungen von Hand aus den gespeicherten Daten einfügen, commiten und pushen

Wir commiten möglichst nach jeder erledigten Arbeit zu einem Thema. Das erleichtert auch das Schreiben von commits, da sie sich nur auf ein Thema beschränken.

Wir schreiben sinnvolle Commit-Nachrichten, die die Veränderungen kurz umreissen. git diff --color in einem separaten Terminal, während dem Commit schreiben, kann hier helfen

Wir benutzen eine sinnvolle Überschrift, die das Thema kurz umreisst. Die ersten 62 Zeichen in der ersten Zeile, werden als Überschrift interpretiert.