<aside> 💡 In dieser Vorlage dokumentierst du, wie Code geprüft werden sollte. Das hift beim Einarbeiten neuer Teammitglieder und hält auch diejenigen, die ausschließlich virtuell arbeiten, auf dem Laufenden.

</aside>

Philosophie

Warum führen wir Code-Prüfungen durch? Welche Leitprinzipien gelten dabei?

Verweise an dieser Stelle gegebenenfalls auch auf andere Seiten, wie zum Beispiel die Entwicklungsleitfäden. Tippe @ und dann den Namen der gewünschten Seite ein, um einen Inline-Link hinzuzufügen: Entwicklungsleitfaden

Code-Prüfung vorbereiten

Gute Vorbereitung ermöglicht eine erfolgreiche Überprüfung.

Commit-Messages

Schreibe gut formulierte, aussagekräftige Commit-Messages.

Github-PR-Beschreibung

Die PR-Beschreibungen sollten die Commit-Messages ergänzen. Beschreibe, was der Commit ändert und wie du die Änderung umgesetzt hast.

Code-Prüfung durchführen

So funktioniert’s

• umfangreiche PRs zweimal prüfen
  • beim ersten Mal: Code-Änderung in seiner Gesamtheit prüfen
  • beim zweiten Mal: semantische Feinheiten unter die Lupe nehmen

Beispiele

var commentCount = 0;

Hier könntest du vorschlagen, dass es let statt var heißen sollte.