Verbessern von Pullanforderungsbeschreibungen mithilfe von Vorlagen

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Das Schreiben guter Pull-Anforderungsbeschreibungen ist eine hervorragende Möglichkeit, um Prüfern zu helfen, zu wissen, was Sie beim Überprüfen von Code erwarten müssen. Sie sind auch eine hervorragende Möglichkeit, um Dinge nachzuverfolgen, die für jede Änderung durchgeführt werden sollten, z. B. Tests, Hinzufügen von Komponententests und Aktualisieren der Dokumentation. Pull-Anforderungsvorlagen können Ihren Entwicklern helfen, großartige Pull-Anforderungsbeschreibungen zu erstellen, die den Standards Ihrer Organisation entsprechen.

In diesem Artikel erfahren Sie, wie Sie mit Pull-Anforderungsvorlagen beginnen.

Voraussetzungen

Was ist eine Pull-Anfrage-Vorlage?

Eine Pull-Anforderungsvorlage ist eine Datei mit Markdown-Text , die ihrer Beschreibung der Pullanforderung 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

Mit Azure Repos können Sie den folgenden Typ von Pullanforderungsvorlagen erstellen:

• Eine Standard Pull-Request-Vorlage, die automatisch für alle neuen Pull-Requests im Repository angewendet wird, es sei denn, sie wird von einer branchespezifischen Pull-Request-Vorlage außer Kraft gesetzt.
• Verzweigungsspezifische Pullanforderungsvorlagen, die automatisch auf Pullanforderungen angewendet werden, die auf eine bestimmte Verzweigung abzielen
• Zusätzliche Pull-Anforderungsvorlagen, die optional vom Ersteller der Pullanforderung hinzugefügt werden können

Der Typ der Pullanforderungsvorlage wird anhand des Dateinamens und des Ordnerspeicherorts bestimmt, wie in den folgenden Abschnitten beschrieben. Bei den Dateinamen und Ordnerspeicherorten wird die Groß-/Kleinschreibung nicht beachtet, sie müssen sich jedoch in der Standardverzweigung Ihres Repositorys befinden.

Standardmäßige Pullanforderungsvorlagen

Standardmäßige Pullanforderungsvorlagen werden automatisch auf das Beschreibungsfeld angewendet, wenn eine neue Pullanforderung erstellt wird. Um Ihr Repository mit einer Standardmäßigen Pullanforderungsvorlage zu konfigurieren, erstellen Sie eine Datei mit dem Namen pull_request_template.md oder pull_request_template.txt speichern Sie sie in der Standardverzweigung Ihres Repositorys in einem der folgenden Ordner.

• Ein Ordner mit dem Namen .azuredevops , der im Stammordner des Repositorys enthalten ist
• Ein Ordner mit dem Namen .vsts , der im Stammordner des Repositorys enthalten ist
• Ein Ordner mit dem Namen docs , der im Stammordner des Repositorys enthalten ist
• Der Stammordner des Repositorys

Es werden mehrere Speicherorte bereitgestellt, um Ihnen flexibilität zu geben, wo Sie Ihre Pull-Anforderungsvorlagen speichern. Wenn eine Pullanforderung erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der angegebenen Reihenfolge und verwendet die erste gefundene Pullanforderungsvorlage.

Wenn eine neue Pullanforderung im Repository erstellt wird, es sei denn, eine branch-spezifische Pullanforderungsvorlage gilt, werden die Inhalte der Standard-Pullanforderungsvorlage verwendet, um das Beschreibungsfeld in der Pullanforderung vorab auszufüllen.

Sie können diese Beschreibung bearbeiten oder hinzufügen und bei Bedarf zusätzliche Pullanforderungsvorlagen anfügen, indem Sie sie aus der Dropdownliste " Vorlage hinzufügen " auswählen.

Verzweigungsspezifische Pull-Request-Vorlagen

Verzweigungsspezifische Pullanforderungsvorlagen können für Pullanforderungen konfiguriert werden, die auf eine bestimmte Verzweigung abzielen. Um Ihr Repository mit einer branchspezifischen Pull-Request-Vorlage zu konfigurieren, erstellen Sie eine .txt oder .md Datei, die nach Ihrem Branch benannt ist. Der Name muss mit der ersten Ebene des Verzweigungsnamens übereinstimmen, z. B. main, dev, release oder feature. Jede branchenspezifische Pull Request-Vorlage wird immer angewendet, wenn eine Pull Request auf diese oder alle darin enthaltenen Verzweigungen abzielt. Die benannte feature.md Pull-Anforderungsvorlage würde beispielsweise angewendet, wenn eine Pullanforderung auf die feature Verzweigung oder alle feature/* Verzweigungen ausgerichtet ist.

Verzweigungsspezifische Pull Request-Vorlagen müssen in der Standardverzweigung Ihres Repositorys mithilfe der folgenden Ordnerhierarchie gespeichert werden: pull_request_template/branches/ Diese Ordner müssen in einem der folgenden Ordner in Ihrem Repository basieren.

• Ein Ordner mit dem Namen .azuredevops , der im Stammordner des Repositorys enthalten ist
• Ein Ordner mit dem Namen .vsts , der im Stammordner des Repositorys enthalten ist
• Ein Ordner mit dem Namen docs , der im Stammordner des Repositorys enthalten ist
• Der Stammordner des Repositorys

Beispielsweise würde eine branchenspezifische Pull-Request-Vorlage, die für alle Pull-Anforderungen in den dev-Branch gilt, mit dev.md oder dev.txt benannt und an einem der folgenden Speicherorte abgelegt werden.

• <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 Standardmäßige Pullanforderungsvorlagen werden mehrere Speicherorte bereitgestellt, um Ihnen Flexibilität bei der Speicherung von Branch-spezifischen Pullanforderungsvorlagen zu bieten. Wenn eine Pullanforderung erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der reihenfolge, die für eine Verzweigungsspezifische Pullanforderungsvorlage angegeben ist, und verwendet den ersten, der dem Verzweigungsnamen entspricht. Wenn keine verzweigungsspezifische Pull-Request-Vorlage gefunden wird, sucht Azure Repos dann nach einer standardmäßigen Pull-Request-Vorlage, wie im vorherigen Abschnitt Standardmäßige Pull-Request-Vorlagen beschrieben.

Zusätzliche Pullanforderungsvorlagen

Zusätzlich zu den standard- und verzweigungsspezifischen Pullanforderungsvorlagen können Sie zusätzliche Pullanforderungsvorlagen konfigurieren. Diese können .md oder .txt Dateien sein, die sich 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 Pullanforderungsvorlagen 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 branchspezifische Vorlage, die standardmäßig auf diesen Pull Request in den dev branch angewendet wurde, wie in der Standardmeldung angegeben, die nach dem Dateinamen aufgelistet ist.
• additional.md - Dies ist eine zusätzliche Vorlage.
• pull_request_template.md - Dies ist normalerweise die Standardvorlage, aber sie wurde von der dev.md branchespezifischen Vorlage in diesem Pull-Request überschrieben. Obwohl sie nicht standardmäßig hinzugefügt wurde, kann sie trotzdem angewendet werden, indem sie aus der Liste ausgewählt wird.

Wählen Sie den Namen der gewünschten zusätzlichen Vorlage aus, um den Inhalt an die aktuelle Beschreibung der Pullanforderung anzufügen.

Siehe auch

• Erstellen einer Pullanforderung zum Überprüfen und Zusammenführen von Code
• Informationen zu Branches und Richtlinien für Branches