Verbessern von Pull Request-Beschreibungen mithilfe von Vorlagen
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
Das Schreiben guter Pull Request-Beschreibungen ist eine hervorragende Möglichkeit, um Reviewern zu vermitteln, was sie beim Code Review erwarten können. PR-Beschreibungen sind auch eine hervorragende Möglichkeit, um Dinge nachzuverfolgen, die für jede Änderung durchgeführt werden sollten, z. B. Testen, Hinzufügen von Komponententests und Aktualisieren der Dokumentation. Pull Request-Vorlagen können Ihren Entwicklern helfen, großartige Pull Request-Beschreibungen zu erstellen, die den Standards Ihrer organization entsprechen.
In diesem Artikel erfahren Sie, wie Sie mit Pull Request-Vorlagen beginnen.
Hinweis
Pull Request-Vorlagen können Eine Anleitung bieten, sind aber nur Empfehlungen. Verwenden Sie Branchrichtlinien, um bewährte Methoden zu erzwingen, z. B. das Anfordern von Pull Requests für wichtige Branches wie Standard, das Erfordern eines erfolgreichen Builds und das Erzwingen erforderlicher Prüfer. Weitere Informationen finden Sie unter Branchrichtlinien.
Was ist eine Pull Request-Vorlage?
Eine Pull Request-Vorlage ist eine Datei mit Markdowntext , der ihrer Pull Request-Beschreibung hinzugefügt wird, wenn der Pull Request 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 können Sie den folgenden Typ von Pull Request-Vorlagen erstellen:
- Eine Standardmäßige Pull Request-Vorlage, die automatisch auf alle neuen Pull Requests im Repository angewendet wird, es sei denn, sie wird von einer branchspezifischen Pull Request-Vorlage überschrieben.
- Branch-spezifische Pull Request-Vorlagen, die automatisch auf Pull Requests für einen bestimmten Branch angewendet werden
- Zusätzliche Pull Request-Vorlagen, die optional vom Pull Request-Ersteller hinzugefügt werden können
Der Typ der Pull Request-Vorlage wird anhand des Dateinamens und des Ordnerspeicherorts bestimmt, wie in den folgenden Abschnitten beschrieben. Bei den Dateinamen und Ordnerspeicherorten wird nicht zwischen Groß- und Kleinschreibung unterschieden, sie müssen sich jedoch im Standardbranch Ihres Repositorys befinden.
Hinweis
Alle Pull Request-Vorlagendateien müssen sich im Standardbranch (in der Regel Standard) Ihres Repositorys befinden. Es werden nur Pull Request-Vorlagendateien aus dem Standardbranch verwendet.
Standardmäßige Pull Request-Vorlagen
Standardmäßige Pull Request-Vorlagen werden automatisch auf das Beschreibungsfeld angewendet, wenn ein neuer Pull Request erstellt wird. Um Ihr Repository mit einer Standard-Pull Request-Vorlage zu konfigurieren, erstellen Sie eine Datei namens pull_request_template.md oderpull_request_template.txt, und speichern Sie sie im Standardbranch Ihres Repositorys in einem der folgenden Ordner.
- Einem Ordner namens
.azuredevops, der im Stammordner des Repositorys enthalten ist. - Einem Ordner namens
.vsts, der im Stammordner des Repositorys enthalten ist. - Einem Ordner namens
docs, der im Stammordner des Repositorys enthalten ist. - Der Stammordner des Repositorys
Es werden mehrere Speicherorte bereitgestellt, um Ihnen flexibilität zu bieten, wo Sie Ihre Pull Request-Vorlagen speichern. Wenn ein Pull Request erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der angegebenen Reihenfolge und verwendet die erste gefundene Standard-Pull Request-Vorlage.
Wenn im Repository ein neuer Pull Request erstellt wird, sofern keine branchspezifische Pull Request-Vorlage angewendet wird, wird der Inhalt der Standard-Pull Request-Vorlage verwendet, um das Beschreibungsfeld im Pull Request vorab aufzufüllen.
Sie können diese Beschreibung bearbeiten oder hinzufügen und bei Bedarf zusätzliche Pull Request-Vorlagen anfügen, indem Sie sie in der Dropdownliste Vorlage hinzufügen auswählen.
Hinweis
Wenn eine standardmäßige oder branchspezifische Pull Request-Vorlage automatisch angewendet wird, ersetzt sie die Standardcommitmeldungen, die normalerweise für die Standardbeschreibung verwendet werden. Sie können sie wieder hinzufügen, indem Sie Commitnachrichten hinzufügen auswählen.
Branchspezifische Pull Request-Vorlagen
Branchspezifische Pull Request-Vorlagen können für Pull Requests konfiguriert werden, die auf einen bestimmten Branch 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 Branchnamens übereinstimmen, z main. B. , dev, releaseoder feature. Jede branchspezifische Pull Request-Vorlage wird jedes Mal angewendet, wenn ein Pull Request auf diesen Branch oder alle darin enthaltenen Branches abzielt. Beispielsweise würde die Pull Request-Vorlage mit dem Namen feature.md angewendet, wenn ein Pull Request auf den feature Branch oder andere feature/* Branches abzielt.
Branchspezifische Pull Request-Vorlagen müssen in der Standardbranch Ihres Repositorys mithilfe der folgenden Ordnerhierarchie gespeichert werden: pull_request_template/branches/. Diese Ordner müssen sich in einem der folgenden Ordner in Ihrem Repository befinden.
- Einem Ordner namens
.azuredevops, der im Stammordner des Repositorys enthalten ist. - Einem Ordner namens
.vsts, der im Stammordner des Repositorys enthalten ist. - Einem Ordner namens
docs, der im Stammordner des Repositorys enthalten ist. - Der Stammordner des Repositorys
Beispielsweise würde eine branchspezifische Pull Request-Vorlage, die für alle Pull Requests in den dev Branch gelten soll, den Namen oder dev.txt erhalten dev.md und sich an einem der folgenden Speicherorte befinden.
<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 Pull Request-Vorlagen werden mehrere Speicherorte bereitgestellt, um Ihnen flexibilität zu bieten, wo Sie branchspezifische Pull Request-Vorlagen speichern. Wenn ein Pull Request erstellt wird, durchsucht Azure Repos die angegebenen Ordner in der angegebenen Reihenfolge nach einer branchspezifischen Pull Request-Vorlage und verwendet die erste Gefundene, die mit dem Branchnamen übereinstimmt. Wenn keine branchspezifische Pull Request-Vorlage gefunden wird, sucht Azure Repos nach einer Standard-Pull Request-Vorlage, wie im vorherigen Abschnitt Standard-Pull Request-Vorlagen beschrieben.
Zusätzliche Pull Request-Vorlagen
Zusätzlich zu den Standard- und Branch-spezifischen Pull Request-Vorlagen können Sie zusätzliche Pull Request-Vorlagen konfigurieren. Dies können Dateien oder .txt sein.md, die sich in einem der folgenden Ordner in Ihrem Standardbranch 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 ein Pull Request erstellt wird, können Sie jede der verfügbaren Pull Request-Vorlagen anfügen, indem Sie sie in der Dropdownliste Vorlage hinzufügen auswählen. Die Namen in der Dropdownliste basieren auf den Dateinamen der Vorlagen.
Im folgenden Beispiel sind drei Vorlagen aufgeführt.
-
dev.md– Dies ist die branchspezifische Vorlage, die standardmäßig auf diesen Pull Request in den Dev-Branch angewendet wurde, wie in der Standardmeldung nach dem Dateinamen angegeben. -
additional.md– Dies ist eine zusätzliche Vorlage. -
pull_request_template.md- Dies ist normalerweise die Standardvorlage, wurde aber von derdev.mdbranchspezifischen Vorlage in diesem Pull Request überschrieben. Obwohl sie nicht standardmäßig hinzugefügt wurde, kann sie dennoch angewendet werden, indem Sie sie aus der Liste auswählen.
Wählen Sie den Namen der gewünschten zusätzlichen Vorlage aus, um deren Inhalt an die aktuelle Pull Request-Beschreibung anzufügen.
Hinweis
Sie können eine Pull Request-Vorlage angeben, um einen übereinstimmenden Standard- oder Branch-spezifischen Pull Request zu überschreiben, indem Sie an die Abfragezeichenfolge anhängen ?template=name.md .