Lektion4
Software Development · Level B1–B2 · 4 min
Code-Reviews, die das Team weiterbringen
Teil 1 Warum ein Code-Review mehr als eine Kontrolle ist Why a code review is more than a check
Im Code-Review prüft eine zweite Person eine Änderung, bevor sie in den Hauptzweig gelangt.
(In a code review, a second person checks a change before it goes into the main branch.)
Dabei geht es nicht nur um Fehler, sondern auch um Lesbarkeit, Tests und geteiltes Wissen im Team.
(It is not only about bugs, but also about readability, tests and shared knowledge in the team.)
Die Engineering-Richtlinien von Google empfehlen, eine Änderung freizugeben, sobald sie die Codequalität insgesamt verbessert, auch wenn sie nicht perfekt ist.
(Google’s engineering guidelines recommend approving a change once it improves the overall code health, even if it isn’t perfect.)
Wortschatz
Der Weg einer Änderung durch das Code-Review
The path of a change through code review
Änderung klein halten
keep the change small
Automatische Tests laufen
automated tests run
Review durch eine Kollegin oder einen Kollegen
review by a colleague
Kommentare einarbeiten
work in the comments
Freigabe und Merge
approval and merge
Änderungen angefordert: zurück ins Review
changes requested: back to review
Teil 2 Drei Regeln für schnelle Reviews Three rules for fast reviews
1. Änderungen klein halten
(1. Keep changes small)
Kleine Pull Requests lassen sich schneller prüfen und leichter zurücknehmen.
(Small pull requests are faster to review and easier to roll back.)
Google nennt etwa 100 Zeilen eine sinnvolle Größe, 1.000 Zeilen sind meistens zu viel.
(Google calls about 100 lines a reasonable size; 1,000 lines are usually too many.)
Wortschatz
2. Innerhalb eines Arbeitstags antworten
(2. Respond within one working day)
Wer auf ein Review wartet, kann oft nicht weiterarbeiten, deshalb gilt ein Arbeitstag als Obergrenze für die erste Antwort.
(Anyone waiting for a review often can’t keep working, so one working day is the upper limit for the first response.)
Wortschatz
3. Kleinigkeiten kennzeichnen
(3. Label minor points)
Mit dem Präfix „Nit:“ markiert man Kleinigkeiten, die den Merge nicht blockieren.
(With the prefix “Nit:”, you mark minor points that don’t block the merge.)
Wortschatz
Source: Google Engineering Practices, “The Standard of Code Review”, “Speed of Code Reviews” and “Small CLs” (google.github.io/eng-practices).
Teil 3 Sätze für den Review-Alltag Phrases for everyday reviews
In vielen Entwicklungsteams duzt man sich, auch in den Kommentaren zum Code.
(In many development teams, people say “du” to each other, in code comments too.)
„Könntest du hier noch einen Test ergänzen?“
Could you add a test here?
„Nit: Die Variable würde ich anders benennen.“
Nit: I would name the variable differently.
„Warum hast du dich für diese Lösung entschieden?“
Why did you choose this solution?
„Sieht gut aus, von meiner Seite freigegeben.“
Looks good, approved from my side.
Wortschatz
Grammatik Grammar rule
Höfliche Bitten mit dem Konjunktiv II
(Polite requests with the Konjunktiv II)
Der Konjunktiv II macht eine Bitte weicher, ohne sie unklar zu machen.
(The Konjunktiv II makes a request softer without making it unclear.)
Man bildet ihn oft mit „würde“ und dem Infinitiv oder mit den Formen „könnte“, „wäre“ und „hätte“.
(It is often formed with “würde” and the infinitive, or with the forms “könnte”, “wäre” and “hätte”.)
Beispiele
(Examples:)
„Könntest du die Methode in zwei Teile aufteilen?“
(“Could you split the method into two parts?”)
„Wäre es möglich, die Konstante in die Konfiguration zu verschieben?“
(“Would it be possible to move the constant into the configuration?”)
„Ich würde hier eher eine Schleife verwenden.“
(“I would rather use a loop here.”)
Merke
(Note:)
Im Review klingt „Könntest du …?“ freundlicher als „Mach …!“, und die Bitte bleibt genauso klar.
(In a review, “Könntest du …?” sounds friendlier than “Mach …!”, and the request stays just as clear.)
Selbsttest der, die oder das? Words from this lesson.
- Änderung change
- Hauptzweig main branch
- Lesbarkeit readability
- Codequalität code quality
- Zeile line
- Arbeitstag working day
- Obergrenze upper limit
- Kleinigkeit minor point, nitpick
die Änderung · der Hauptzweig · die Lesbarkeit · die Codequalität · die Zeile · der Arbeitstag · die Obergrenze · die Kleinigkeit
Weiterlesen im Buch
German for IT Project Managers: Hybrid Projects, Status Reports and Steering Committees · Interaktiver Berufsroman
The same page as this article, a whole book long: German texts from your profession, the English after every sentence, the words and the grammar after every text.