Pull-Request-Richtlinien: so schreibt man gute Pull Requests
Kommentare

Die Kommunikation im Netz bietet viele Stolpersteine, insbesondere, was den Ton einer Unterhaltung und den Umgang mit anderen angeht. Richtlinien sind daher nötig, um Probleme so gering wie möglich zu halten.

Was beispielsweise für E-Mails, Foren oder Chats gilt, gilt genauso für das Verfassen und Bearbeiten von Pull Request. GitHub hat daher Guidelines zum Schreiben von Pull Requests verfasst, die im GitHub-Blog vorgestellt wurden.

Pull Requests schreiben

Ein häufiges Problem bei der gemeinsamen Arbeit an Pull Requests ist mangelhafte Kommunikation. Darum sollten einige Punkte beachtet werden, wenn ein Pull Request für ein Projekt verfasst wird.

So sollte in jedem Fall der Grund für den Pull Request angegeben und idealerweise ein kurzer Abriss über die Gründe für die Arbeit zur Verfügung gestellt werden. Genauso sollte der Pull Request informativ verfasst und auch für Projekt-Außenstehende leicht nachvollziehbar sein.

Ebenso wichtig ist es, einerseits explizit zu erklären, wann Feedback erwünscht ist (etwa durch einen Vermerk Work in Progress im Titel, falls noch weitere Änderungen aufgenommen werden sollen); andererseits auch ausdrücklich zu sagen, welche Art von Feedback man braucht. Zudem sollten Teams und einzelne Person, deren Beteiligung man sich wünscht sowie die Gründe dafür, genannt werden.

Feedback zu Pull Requests geben

Auch wenn man zu bestehenden Pull Requests Feedback abgeben möchte, hilft es allen Beteiligten, wenn man einige Richtlinien beachtet. Dazu gehört vor allem, sich mit dem Kontext des Problems vertraut zu machen. Genauso sollte man versuchen, Möglichkeiten anzubieten, wie Code vereinfacht werden kann – am besten, indem man den Verfasser des Pull Requests mithilfe von Fragen in die Überlegungen miteinbezieht und gleichzeitig Gründe für die Änderungsvorschläge gibt.

Auf jeden Fall sollte auf den Ton der Unterhaltung geachtet und auf abfällige Bemerkungen zu der Arbeit anderer verzichtet werden. Neutrale Sprache wird online häufig als negativ wahrgenommen; der Einsatz von Emojis kann dazu beitragen, den Ton klarzustellen.

Auf Feedback reagiert man am besten mit einem Ausdruck von Anerkennung – immerhin hat sich jemand die Mühe gemacht, Feedback zur Verfügung zu stellen. Sind beim erhaltenen Feedback immer noch Punkte unklar, sollte nachgefragt und auf mögliche folgende Pull Requests oder Commits verwiesen werden.

Mithilfe dieser Richtlinien dürfte das Verfassen von Pull Requests und die Kommunikation mit anderen Community-Mitgliedern deutlich leichter fallen und so allen Beteiligten von Nutzen sein.

Aufmacherbild: guidelines marked on rubber stamp in hand von Shutterstock / Urheberrecht: filmfoto

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -