Ratgeber · Devlingo

Code Review Kommentare: englische Sätze, die nicht unhöflich klingen

Kurze Antwort

Code Review Kommentare auf Englisch wirken freundlich, wenn sie über den Code sprechen statt über die Person und die Absicht klar machen. Google empfiehlt Präfixe wie „Nit:“ für Kleinigkeiten, „Optional:“ für Vorschläge und „FYI:“ für reine Hinweise. Conventional Comments ergänzt Labels wie „suggestion“, „issue“ und „praise“, dazu den Hinweis „blocking“.

Aktualisiert am 3 Min. LesezeitGambit Studio

Ohne Installation nutzen →Kostenlos im Browser, ohne Konto

Die Präfixe von Google

PräfixBedeutung
Nit:Kleinigkeit; sollte geändert werden, beeinflusst den Code aber kaum
Optional: / Consider:Vorschlag, keine Pflicht
FYI:Info für später, keine Änderung in diesem PR erwartet

Conventional Comments

Das Format lautet label (decorations): subject, zum Beispiel suggestion (non-blocking): extract this into a helper.

LabelWofür
praiseEtwas ehrlich loben; mindestens einmal pro Review
nitpickKleinigkeit, Geschmackssache, blockiert nicht
suggestionVerbesserungsvorschlag mit Begründung
issueKonkretes Problem, am besten mit Vorschlag
questionRückfrage, etwas ist unklar
todoKleine, aber nötige Änderung
thoughtIdee, nicht blockierend
noteHinweis, immer nicht blockierend

Dazu kommen die Zusätze (blocking), (non-blocking) und (if-minor): nur ändern, wenn es wenig Aufwand ist.

15 Sätze, die freundlich klingen

EnglischAuf Deutsch
Nice approach! Could we add a test for the empty list?Guter Ansatz! Können wir einen Test für die leere Liste ergänzen?
What do you think about extracting this into a helper?Was hältst du davon, das in eine Hilfsfunktion auszulagern?
I might be missing something, why do we need the extra query?Vielleicht übersehe ich etwas, wozu brauchen wir die zusätzliche Abfrage?
Nit: typo in the variable name.Kleinigkeit: Tippfehler im Variablennamen.
Optional: this could be a one-liner.Optional: Das ginge auch in einer Zeile.
FYI: there's a shared util for this in core.Zur Info: Dafür gibt es ein gemeinsames Util in core.
This will break if the user ID is null.Das bricht, wenn die User-ID null ist.
Could you add a comment explaining why?Kannst du einen Kommentar ergänzen, der das Warum erklärt?
Let's keep this PR focused and do the refactor separately.Lass uns den PR fokussiert halten und das Refactoring getrennt machen.
I'm happy to pair on this if it helps.Ich helfe gern im Pair Programming, wenn das hilft.
Thanks for the clear description!Danke für die klare Beschreibung!
Good catch, fixed in the latest commit.Gut gesehen, im letzten Commit behoben.
I'd prefer to keep it as is, because the order matters here.Ich würde es lieber lassen, weil die Reihenfolge hier wichtig ist.
Resolved, thanks!Erledigt, danke!
LGTM once the tests pass.Freigabe, sobald die Tests grün sind.

Die Freigabe-Kürzel erklärt der Ratgeber LGTM Bedeutung, die PR-Begriffe der Ratgeber Pull Request.

Das Englisch des Entwickleralltags, nicht das Touristen-Englisch

Devlingo, die App von Gambit Studio für Englisch im Entwickleralltag, bringt dir über 3.600 Sätze aus der Tech-Arbeit bei, in 12 Kategorien: Code Review, Pull Requests, Bug Reports, Pair Programming, technische Diskussionen, Documentation und mehr. Jeden Tag kommen 10 neue Sätze mit Kontext, Aussprache-Hinweisen und Beispielen dazu, und der Satz des Tages erscheint als Widget auf dem Home-Bildschirm des iPhones. Die Oberfläche gibt es auch auf Deutsch.

Quellen

  1. Google Engineering Practices: How to write code review comments
  2. Conventional Comments

Häufige Fragen

Was am häufigsten gefragt wird, beantwortet mit Quelle.

Wie schreibe ich Code-Review-Kommentare auf Englisch höflich?
Über den Code sprechen, nicht über die Person, und Vorschläge als Frage formulieren: „What do you think about …?“
Was heißt „Nit:“ in einem Review?
Eine Kleinigkeit: Sie sollte geändert werden, ist aber kein großes Problem.
Was sind Conventional Comments?
Ein Format mit Labels wie suggestion, issue oder praise und Zusätzen wie (blocking), damit die Absicht eines Kommentars klar ist.
Wie antworte ich auf einen Review-Kommentar?
„Good catch, fixed“ oder, wenn du anderer Meinung bist, mit Begründung: „I'd prefer to keep it, because …“
Was ist der Unterschied zwischen blocking und non-blocking?
Blocking muss vor dem Merge gelöst werden, non-blocking nicht.
DevlingoBusiness Phrasen & Vokabeln
Ohne Installation nutzenLaden