Beschrijvingen van pull-aanvragen verbeteren met behulp van sjablonen

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Het schrijven van goede beschrijvingen van pull-aanvragen is een uitstekende manier om revisoren te helpen weten wat ze kunnen verwachten bij het beoordelen van code. Ze zijn ook een uitstekende manier om dingen bij te houden die moeten worden uitgevoerd voor elke wijziging, zoals testen, het toevoegen van eenheidstests en het bijwerken van documentatie. Met pull-aanvraagsjablonen kunnen uw ontwikkelaars geweldige beschrijvingen van pull-aanvragen maken die voldoen aan de standaarden van uw organisatie.

In dit artikel leest u hoe u aan de slag gaat met pull-aanvraagsjablonen.

Notitie

Sjablonen voor pull-aanvragen kunnen richtlijnen bieden, maar zijn alleen advies. Gebruik vertakkingsbeleid om best practices af te dwingen, zoals het vereisen van pull-aanvragen voor belangrijke vertakkingen, zoals de belangrijkste, het vereisen van een geslaagde build en het afdwingen van vereiste revisoren. Zie vertakkingsbeleidvoor meer informatie.

Benodigdheden

Categorie	Vereisten
Toegang tot het project	Lid van een project.
toestemmingen	- Code weergeven in privéprojecten: minimaal Basis toegang. - Klonen of bijdragen aan code in privéprojecten: Lid van de Inzenders beveiligingsgroep of bijbehorende machtigingen in het project. - Machtigingen instellen voor vertakking of opslagplaats: Beheer machtigingen voor de vertakking of opslagplaats. - Standaardtak wijzigen: beleid bewerken machtigingen voor de opslagplaats. - Een opslagplaats importeren: Lid van de Projectbeheerders beveiligingsgroep of Git-projectniveau Opslagplaats maken machtiging ingesteld op Toestaan. Zie Machtigingen voor Git-opslagplaatsen instellen voor meer informatie.
Diensten	Repositories ingeschakeld.
Gereedschappen	Facultatief. Gebruik az repos opdrachten: Azure DevOps CLI.

Notitie

In openbare projecten hebben gebruikers met Stakeholder volledige toegang tot Azure Repos, waaronder het weergeven, klonen en bijdragen aan code.

Wat is een pull-aanvraagsjabloon?

Een pull-aanvraagsjabloon is een bestand met Markdown- tekst die wordt toegevoegd aan de beschrijving van uw pull-aanvraag wanneer de pull-aanvraag wordt gemaakt.

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

Met Azure Repos kunt u de volgende soorten pull-aanvraagsjablonen maken:

• Een standaardsjabloon voor pull-aanvragen die automatisch wordt toegepast op alle nieuwe pull-aanvragen in de opslagplaats, tenzij deze wordt overschreven door een branche-specifieke pull-aanvraagsjabloon.
• Branch-specifieke pull-aanvraagsjablonen die automatisch worden toegepast op pull requests die gericht zijn op een specifieke branch
• Aanvullende pull-aanvraagsjablonen die optioneel kunnen worden toegevoegd door de maker van de pull-aanvraag

Het type pull-aanvraagsjabloon wordt bepaald door de bestandsnaam en maplocatie, zoals beschreven in de volgende secties. De bestandsnamen en maplocaties zijn niet hoofdlettergevoelig, maar moeten zich in de standaardbranch van uw opslagplaats bevinden.

Notitie

Alle sjabloonbestanden voor pull-aanvragen moeten zich in de standaardbranch (meestal hoofd) van uw opslagplaats bevinden. Alleen pull-aanvraagsjabloonbestanden uit de standaardbranch worden gebruikt.

Standaardsjablonen voor pull-aanvragen

Standaardsjablonen voor pull-aanvragen worden automatisch toegepast op het beschrijvingsveld wanneer er een nieuwe pull-aanvraag wordt gemaakt. Als u uw opslagplaats wilt configureren met een standaardsjabloon voor pull-aanvragen, maakt u een bestand met de naam pull_request_template.md of pull_request_template.txt en slaat u deze op in de standaardbranch van uw opslagplaats in een van de volgende mappen.

• Een map met de naam .azuredevops die zich in de hoofdmap van de opslagplaats bevindt
• Een map met de naam .vsts die zich in de hoofdmap van de opslagplaats bevindt
• Een map met de naam docs die zich in de hoofdmap van de opslagplaats bevindt
• De hoofdmap van de opslagplaats

Er zijn meerdere locaties beschikbaar om u flexibiliteit te bieden bij het opslaan van uw pull-aanvraagsjablonen. Wanneer een pull-aanvraag wordt gemaakt, doorzoekt Azure Repos de aangewezen mappen in de opgegeven volgorde en gebruikt de eerste standaardsjabloon voor pull-aanvragen die wordt gevonden.

Wanneer een nieuwe pull-aanvraag wordt gemaakt in de opslagplaats, tenzij een vertakkingsspecifieke pull-aanvraagsjabloon van toepassing is, wordt de inhoud van de standaardsjabloon voor pull-aanvragen gebruikt om het beschrijvingsveld in de pull-aanvraag vooraf in te vullen.

U kunt deze beschrijving bewerken of toevoegen en extra pull-aanvraagsjablonen toevoegen desgewenst door deze te selecteren in de vervolgkeuzelijst Een sjabloon toevoegen.

Notitie

Wanneer automatisch een standaard- of vertakkingsspecifieke pull-aanvraagsjabloon wordt toegepast, worden de standaarddoorvoeringsberichten vervangen die meestal worden gebruikt voor de standaardbeschrijving. U kunt ze weer toevoegen door Doorvoerberichten toevoegente selecteren.

Vertakkingsspecifieke pull-aanvraagsjablonen

Vertakkingsspecifieke pull-aanvraagsjablonen kunnen worden geconfigureerd voor pull-aanvragen die zijn gericht op een specifieke vertakking. Als u uw opslagplaats wilt configureren met een vertakkingsspecifieke pull-aanvraagsjabloon, maakt u een .txt- of .md-bestand met de naam van uw vertakking. De naam moet overeenkomen met het eerste niveau van de vertakkingsnaam, zoals main, dev, releaseof feature. Elke branchspecifieke pull request-sjabloon wordt toegepast wanneer een pull-aanvraag zich richt op die specifieke branch of op de sub-branches die daaronder vallen. De pull-aanvraagssjabloon genaamd feature.md wordt bijvoorbeeld toegepast als een pull-aanvraag zich richt op de feature branch of op een van de feature/* branches.

Vertakkingsspecifieke pull-aanvraagsjablonen moeten worden opgeslagen in de standaardbranch van uw opslagplaats met behulp van de volgende maphiërarchie: pull_request_template/branches/. Deze mappen moeten zijn gebaseerd op een van de volgende mappen in uw opslagplaats.

• Een map met de naam .azuredevops die zich in de hoofdmap van de opslagplaats bevindt
• Een map met de naam .vsts die zich in de hoofdmap van de opslagplaats bevindt
• Een map met de naam docs die zich in de hoofdmap van de opslagplaats bevindt
• De hoofdmap van de opslagplaats

Een vertakkingsspecifieke pull-aanvraagsjabloon die van toepassing moet zijn op alle pull-aanvragen in de dev vertakking, krijgt bijvoorbeeld de naam dev.md of dev.txt en bevindt zich op een van de volgende locaties.

• <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/

Net als bij standaardsjablonen voor pull-aanvragen worden er meerdere locaties geboden om u flexibiliteit te bieden bij het opslaan van branchspecifieke pull-aanvraagsjablonen. Wanneer er een pull request wordt aangemaakt, doorzoekt Azure Repos de aangewezen mappen in de opgegeven volgorde voor een branchespecifieke pull request-sjabloon en gebruikt het de eerste die overeenkomt met de branchnaam. Als er geen pull-aanvraagsjabloon voor specifieke vertakkingen wordt gevonden, zoekt Azure Repos naar een standaardsjabloon voor pull-aanvragen, zoals beschreven in de eerder genoemde sectie Standaardsjablonen voor pull-aanvragen.

Aanvullende sjablonen voor pull-aanvragen

Naast de standaard- en vertakkingsspecifieke pull-aanvraagsjablonen kunt u aanvullende sjablonen voor pull-aanvragen configureren. Dit kunnen .md of .txt bestanden zijn, die zich in een van de volgende mappen in uw standaardbranch bevinden.

• <repository root>/.azuredevops/pull_request_template/
• <repository root>/.vsts/pull_request_template/
• <repository root>/docs/pull_request_template/
• <repository root>/pull_request_template/

Wanneer een pull-aanvraag wordt gemaakt, kunt u een van de beschikbare pull-aanvraagsjablonen toevoegen door deze te kiezen in de vervolgkeuzelijst Een sjabloon toevoegen. De namen in de vervolgkeuzelijst zijn gebaseerd op de bestandsnamen van de sjablonen.

In het volgende voorbeeld worden drie sjablonen weergegeven.

• dev.md: dit is de vertakkingsspecifieke sjabloon die standaard is toegepast op deze pull-aanvraag in de dev-vertakking, zoals aangegeven door het standaardbericht weergegeven na de bestandsnaam.
• additional.md: dit is een extra sjabloon.
• pull_request_template.md: dit is normaal gesproken de standaardsjabloon, maar deze is overschreven door de dev.md branch-specifieke sjabloon in deze pull-aanvraag. Hoewel deze niet standaard is toegevoegd, kan deze nog steeds worden toegepast door deze te selecteren in de lijst.

Selecteer de naam van de gewenste aanvullende sjabloon om de inhoud toe te voegen aan de huidige beschrijving van de pull-aanvraag.

Notitie

U kunt een pull-aanvraagsjabloon opgeven om een overeenkomende standaard- of vertakkingsspecifieke pull-aanvraag te overschrijven door ?template=name.md toe te voegen aan de querytekenreeks.

Zie ook

• een pull-aanvraag maken om code- te controleren en samen te voegen
• Over vertakkingen en takbeleid