Verbessern von Pull-Anforderungsbeschreibungen mithilfe von Vorlagen
Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019
Das Schreiben guter Pull-Anforderungsbeschreibungen ist eine großartige Möglichkeit, Prüfern zu helfen, zu wissen, was beim Überprüfen von Code erwartet werden soll. Sie sind auch eine großartige Möglichkeit, Dinge zu verfolgen, die für jede Änderung durchgeführt werden sollten, z. B. Tests, Hinzufügen von Komponententests und Aktualisieren von Dokumentationen. Pull-Anforderungsvorlagen können Ihren Entwicklern helfen, hervorragende Pull-Anforderungsbeschreibungen zu erstellen, die den Standards Ihrer Organisation entsprechen.
In diesem Artikel erfahren Sie, wie Sie mit Pull-Anforderungsvorlagen beginnen.
Hinweis
Pull-Anforderungsvorlagen können Anleitungen bereitstellen, aber nur beratungen. Verwenden Sie Verzweigungsrichtlinien, um bewährte Methoden zu erzwingen, z. B. Die Anforderung von Pullanforderungen für Schlüsselzweige wie haupt, erfordert einen erfolgreichen Build und erzwingen erforderliche Prüfer. Weitere Informationen finden Sie unter Verzweigungsrichtlinien.
Was ist eine Pull-Anforderungsvorlage?
Eine Pull-Anforderungsvorlage ist eine Datei mit Markdown-Text , die Ihrer Pullanforderungsbeschreibung hinzugefügt wird, wenn die Pullanforderung erstellt wird.
Thank you for your contribution to the Fabrikam Fiber repo.
Before submitting this PR, please make sure:
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests
Azure Repos ermöglicht Es Ihnen, den folgenden Pull-Anforderungsvorlagentyp zu erstellen:
- Eine Standard-Pull-Anforderungsvorlage, die automatisch für alle neuen Pull-Anforderungen im Repository angewendet wird, es sei denn, es sei denn, sie werden von einer branchspezifischen Pull-Anforderungsvorlage außer Kraft gesetzt.
- Branch-spezifische Pull-Anforderungsvorlagen, die automatisch auf Pull-Anforderungen angewendet werden, die auf eine bestimmte Verzweigung abzielen
- Zusätzliche Pull-Anforderungsvorlagen, die optional vom Pull-Anforderungs-Creator hinzugefügt werden können
Der Typ der Pull-Anforderungsvorlage wird durch den Dateinamen und den Ordnerspeicherort bestimmt, wie in den folgenden Abschnitten beschrieben. Die Dateinamen und Ordnerspeicherorte sind nicht groß- und kleinschreibungsempfindlich, müssen sich jedoch im Standardzweig Ihres Repositorys befinden.
Hinweis
Alle Pull-Anforderungsvorlagendateien müssen sich im Standardzweig (in der Regel Haupt) Ihres Repositorys befinden. Nur Pull-Anforderungsvorlagendateien aus dem Standardzweig werden verwendet.
Standard-Pull-Anforderungsvorlagen
Standardmäßige Pull-Anforderungsvorlagen werden automatisch auf das Beschreibungsfeld angewendet, wenn eine neue Pullanforderung erstellt wird. Wenn Sie Ihr Repository mit einer Standard-Pull-Anforderungsvorlage konfigurieren möchten, erstellen Sie eine Datei namens pull_request_template.md oder pull_request_template.txt speichern Sie sie in einem der folgenden Ordner im Standardzweig Ihres Repositorys.
- Ein Ordner mit dem Namen,
.azuredevopsder im Stammordner des Repositorys enthalten ist - Ein Ordner mit dem Namen,
.vstsder im Stammordner des Repositorys enthalten ist - Ein Ordner mit dem Namen,
docsder im Stammordner des Repositorys enthalten ist - Der Stammordner des Repositorys
Mehrere Speicherorte werden bereitgestellt, um Ihnen Flexibilität zu bieten, in der Sie Ihre Pull-Anforderungsvorlagen speichern. Wenn eine Pullanforderung erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der angegebenen Reihenfolge und verwendet die erste standardmäßige Pull-Anforderungsvorlage, die sie findet.
Wenn eine neue Pullanforderung im Repository erstellt wird, sofern keine branchspezifische Pull-Anforderungsvorlage gilt, werden die Inhalte der Standard-Pull-Anforderungsvorlage verwendet, um das Beschreibungsfeld in der Pullanforderung vorzufüllen.
Sie können diese Beschreibung bearbeiten oder hinzufügen und zusätzliche Pull-Anforderungsvorlagen anfügen, wenn gewünscht, indem Sie sie aus der Dropdownliste "Vorlage hinzufügen " auswählen.
Hinweis
Wenn eine Standard- oder Verzweigungsanforderungsvorlage automatisch angewendet wird, ersetzt sie die Standard-Commitnachrichten, die in der Regel für die Standardbeschreibung verwendet werden. Sie können sie wieder hinzufügen, indem Sie "Commitnachrichten hinzufügen" auswählen.
Branch-spezifische Pull-Anforderungsvorlagen
Branch-spezifische Pull-Anforderungsvorlagen können für Pullanforderungen konfiguriert werden, die auf einen bestimmten Zweig abzielen. Um Ihr Repository mit einer branchspezifischen Pull-Anforderungsvorlage zu konfigurieren, erstellen Sie eine .txt oder .md eine Datei, die nach Ihrem Zweig benannt ist. Der Name muss mit der ersten Ebene des Zweignamens übereinstimmen, zmain. B. , , devreleaseoder feature. Jede verzweigte spezifische Pull-Anforderungsvorlage wird jedes Mal angewendet, wenn eine Pull-Anforderung zielt, die verzweigt oder alle Unterzweige enthalten sind. Beispielsweise würde die Benannte Pull-Anforderungsvorlage feature.md angewendet werden, wenn eine Pullanforderung auf die feature Verzweigung oder alle feature/* Zweige ausgerichtet ist.
Verzweigungsspezifische Pull-Anforderungsvorlagen müssen im Standardzweig Ihres Repositorys mit der folgenden Ordnerhierarchie gespeichert werden: pull_request_template/branches/ Diese Ordner müssen in einem der folgenden Ordner im Repository basieren.
- Ein Ordner mit dem Namen,
.azuredevopsder im Stammordner des Repositorys enthalten ist - Ein Ordner mit dem Namen,
.vstsder im Stammordner des Repositorys enthalten ist - Ein Ordner mit dem Namen,
docsder im Stammordner des Repositorys enthalten ist - Der Stammordner des Repositorys
Beispielsweise würde eine branchspezifische Pull-Anforderungsvorlage, die auf alle Pullanforderungen in den dev Zweig angewendet werden soll, benannt dev.md oder dev.txt in einem der folgenden Speicherorte liegen.
<repository root>/.azuredevops/pull_request_template/branches/<repository root>/.vsts/pull_request_template/branches/<repository root>/docs/pull_request_template/branches/<repository root>/pull_request_template/branches/
Genau wie Standard-Pull-Anforderungsvorlagen werden mehrere Speicherorte bereitgestellt, um Ihnen flexibilität zu ermöglichen, wo Sie branchspezifische Pull-Anforderungsvorlagen speichern. Wenn eine Pullanforderung erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der Reihenfolge, die für eine branchspezifische Pull-Anforderungsvorlage angegeben wird, und verwendet den ersten, der dem Verzweigungsnamen entspricht. Wenn keine branchspezifische Pull-Anforderungsvorlage gefunden wird, sucht Azure Repos dann nach einer Standard-Pull-Anforderungsvorlage wie im vorherigen Abschnitt "Standard-Pull-Anforderungsvorlagen" beschrieben.
Zusätzliche Pull-Anforderungsvorlagen
Zusätzlich zu den standard- und branchspezifischen Pull-Anforderungsvorlagen können Sie zusätzliche Pull-Anforderungsvorlagen konfigurieren. Diese können .md sich .txt in einem der folgenden Ordner in Ihrem Standardzweig befinden.
<repository root>/.azuredevops/pull_request_template/<repository root>/.vsts/pull_request_template/<repository root>/docs/pull_request_template/<repository root>/pull_request_template/
Wenn eine Pullanforderung erstellt wird, können Sie eine der verfügbaren Pull-Anforderungsvorlagen anfügen, indem Sie sie aus der Dropdownliste "Vorlage hinzufügen " auswählen. Die Namen in der Dropdownliste basieren auf den Dateinamen der Vorlagen.
Im folgenden Beispiel werden drei Vorlagen aufgelistet.
dev.md- Dies ist die verzweigte spezifische Vorlage, die standardmäßig auf diese Pullanforderung in den Dev Branch angewendet wurde, wie durch die standardnachricht angegeben, die nach dem Dateinamen aufgeführt ist.additional.md- Dies ist eine zusätzliche Vorlage.pull_request_template.md- Dies ist normalerweise die Standardvorlage, aber sie wurde von derdev.mdverzweigten spezifischen Vorlage in dieser Pullanforderung außer Kraft gesetzt. Obwohl sie standardmäßig nicht hinzugefügt wurde, kann sie weiterhin angewendet werden, indem Sie sie aus der Liste auswählen.
Wählen Sie den Namen der gewünschten zusätzlichen Vorlage aus, um ihren Inhalt an die aktuelle Pull-Anforderungsbeschreibung anzufügen.
Hinweis
Sie können eine Pull-Anforderungsvorlage angeben, um alle übereinstimmenden Standard- oder Branch-spezifische Pull-Anforderung außer Kraft zu setzen, indem Sie an die Abfragezeichenfolge anfügen ?template=name.md .