Problem
Pull Requests und Code Reviews sollten uns allen hoffentlich ein Begriff sein. Gutes Feedback geben ist generell aber gar nicht so leicht – egal ob man dabei in seiner Muttersprache kommentiert oder in einer anderen Sprache. Zudem ist die menschliche Kommunikation von Natur aus uneindeutig und unterliegt Tagesform, Emotionen und individueller Eloquenz. Da wäre es doch gut, wenn man ein Tool hätte, um zumindest die Absicht und Wichtigkeit vom gegebenen Feedback klarzustellen.
Lösung
Dekoriert eure Kommentare einfach mit standardisierten Labels! Als Vorschlag dazu dienen die Conventional Comments. Diese nennen z. B. Labels wie nitpick, suggestion, todo, question, thought, typo. Leitet man seinen Kommentar mit so einer Kategorie ein, kann der oder die Leser*in besser erkennen, wie es gemeint ist. Um dem Beitrag noch mehr Kontext zu geben, kann man dem Label weitere "Auszeichnungen" geben. Das eignet sich vor allem dazu, dem Gegenüber zu signalisieren, für wie wichtig man eine Änderung hält (blocking vs. non-blocking).
Beispiel
Ich sehe eine neue Methode in einem PR von einer Kollegin oder einem Kollegen, so richtig zufrieden bin ich mit dem Naming aber nicht. Ich kommentiere:
Richtig konstruktiv, oder? So könnte man das Feedback verbessern:
Habe ich die Methode nicht richtig verstanden?
Passt der Name nicht zu dem, was die Methode macht?
Gibt es einen Konflikt mit einer schon bestehenden Methode?
Habe ich einen besseren Vorschlag?
Etwas mehr Kontext/Intention zu geben, sollte mir im Moment des Reviews nicht viel Mehraufwand erzeugen. Vielleicht hilft es sogar mir selbst, nach dem Urlaub noch zu verstehen, wie ich den Kommentar gemeint habe.
Weiterführende Aspekte:
- Die "vollständige" Doku dazu ist leicht verdaulich und unter Conventional Comments zu finden.
- Es wäre auch völlig in Ordnung, wenn ihr euch im Team eigene Labels ausdenkt, z. B. wenn ihr in euren PRs in anderen Sprachen als Englisch kommunizieren wollt. Einfach ausprobieren und eine Konvention finden, welche in eurem Team gut funktioniert.
- Verteilt auch mal ein praise! Ist doch ganz nett, mal anzumerken, wenn etwas clever gelöst oder aufwändig refactored wurde?
