So verwenden Sie GitHub-PR-Vorlagen

Wenn Sie irgendetwas tun – unabhängig davon, ob es sich um Open Source oder Closed Source handelt – (obwohl ich weiß, dass die meisten Benutzer von read this site an Open Source beteiligt sind), verwenden Sie wahrscheinlich eine Quellcodeverwaltung, und es ist wahrscheinlich GitHub.

Viele von Ihnen verfolgen entweder ein Projekt, tragen zu einem Projekt bei oder bearbeiten Pull-Requests für ein Projekt. Und was ist mit den Projekten, an denen Sie im Team arbeiten?

Vielleicht sieht Ihr Workflow so aus:

• Sie erstellen einen Branch, um an einem Feature zu arbeiten,
• Sie pushen den Branch, um die von Ihnen geleistete Arbeit für einen Peer zur Überprüfung zu detaillieren,
• die Bewertung wird zusammengeführt,
• machen Sie weiter.

Aber was fügen Sie in die Vorlage für den Pull-Request ein? Ist es jedes Mal gleich oder ist es anders? Was ist, wenn der Inhalt der PR sich auf etwas in Trello, Asana, Basecamp oder einem anderen Projektmanagementsystem bezieht?

Hier kommen GitHub PR-Vorlagen ins Spiel.

GitHub-PR-Vorlagen

Sie können alles über sie auf der Seite lesen, aber hier ist das Wesentliche (kein Wortspiel beabsichtigt):

Es ist schwer, ein Problem zu lösen, wenn wichtige Details fehlen. Jetzt können Projektbetreuer Vorlagen für Issues und Pull-Requests zu Projekten hinzufügen und Mitwirkende dabei unterstützen, die richtigen Details zu Beginn eines Threads zu teilen

Und die Idee ist einfach: Wir erstellen Vorlagen für Issues und Pull-Requests für andere, die eine Informationsebene bereitstellen, die sie ausfüllen müssen, bevor sie ein Issue oder einen Pull-Request einreichen.

Dies hilft uns, da Betreuer wissen, welche Informationen wir benötigen, bevor sie sich damit befassen. Darüber hinaus kann es uns ermöglichen, auf eine frühere Ausgabe, ein früheres Ticket oder irgendetwas im Zusammenhang mit dem Projekt zu verlinken.

Angenommen, Sie arbeiten an einem Projekt und möchten die folgenden Informationen einbeziehen:

• eine kurze Beschreibung dessen, was der PR tut, damit der Betreuer nicht raten muss,
• den Status des PR, ob es bereit sein sollte, zusammengeführt zu werden, oder ob es sich noch in der Entwicklung befindet, aber für eine Überprüfung bereit ist,
• einen Link zu dem Ticket in Ihrem Projektmanager, für das der PR relevant ist.

Ich sage nicht, dass dies die erforderlichen Informationen sind, aber wir haben sie verwendet und für nützlich befunden (und es ist schön zu sehen, dass im Laufe der Zeit weitere Verbesserungen vorgenommen werden ).

Aber wie nutzen wir das?

Die Seite ist ziemlich übersichtlich, aber es ist wirklich einfach. Sie benötigen die folgenden Dateien in Ihrem Projektverzeichnis oder in der. github- Verzeichnis:

• ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE

Jede dieser Dateien sollte Markdown-Dateien sein, die genau das ausdrücken, was Ihre Mitwirkenden einbeziehen sollen, wenn sie, wissen Sie, in irgendeiner Weise zu Ihrem Projekt beitragen.

Und wenn ein Benutzer dann versucht, ein Problem zu melden oder eine Pull-Anfrage zu erstellen, hat er die Informationen aus der Vorlage dazu aufgefordert.

Schön, nicht wahr?

Es ist nicht viel, aber …

Sie denken vielleicht nicht, dass es viel ist, aber es ist ziemlich einfach, die Qualität der in ein Projekt eingehenden Informationen zu verbessern, Ihre Mitwirkenden darüber nachdenken zu lassen, was sie in das Projekt einbringen, und dann entsprechend zu reagieren.

Außerdem hilft es Ihnen und dem Rest Ihres Teams zu verstehen, was überprüft werden soll, und sich auf Änderungen vorzubereiten, die bei der Arbeit an diesen Projekten auftreten können.