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 te helpen bij het bijhouden van dingen die moeten worden gedaan 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 wordt beschreven 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 sleutelvertakkingen zoals main, het vereisen van een geslaagde build en het afdwingen van vereiste revisoren. Zie Vertakkingsbeleid voor meer informatie.
Wat is een pull-aanvraagsjabloon?
Een pull-aanvraagsjabloon is een bestand met Markdown-tekst dat 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-opslagplaatsen kunt u het volgende type 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 vertakkingsspecifieke pull-aanvraagsjabloon
- Sjablonen voor vertakkingsspecifieke pull-aanvragen die automatisch worden toegepast op pull-aanvragen die gericht zijn op een specifieke vertakking
- 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 ze 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 sjabloonbestanden voor pull-aanvragen van de standaardbranch worden gebruikt.
Standaardsjablonen voor pull-aanvragen
Standaardsjablonen voor pull-aanvragen worden automatisch toegepast op het beschrijvingsveld wanneer 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 dit op in de standaardbranch van uw opslagplaats in een van de volgende mappen.
- Een map met de naam
.azuredevopsdie zich in de hoofdmap van de opslagplaats bevindt - Een map met de naam
.vstsdie zich in de hoofdmap van de opslagplaats bevindt - Een map met de naam
docsdie zich in de hoofdmap van de opslagplaats bevindt - De hoofdmap van de opslagplaats
Er worden meerdere locaties geboden om u flexibiliteit te bieden bij het opslaan van uw pull-aanvraagsjablonen. Wanneer een pull-aanvraag wordt gemaakt, doorzoekt Azure Opslagplaatsen de aangewezen mappen in de opgegeven volgorde en wordt de eerste standaardsjabloon voor pull-aanvragen gebruikt die wordt gevonden.
Wanneer een nieuwe pull-aanvraag wordt gemaakt in de opslagplaats, wordt, tenzij een vertakkingsspecifieke pull-aanvraagsjabloon van toepassing is, de inhoud van de standaardsjabloon voor pull-aanvragen gebruikt om het beschrijvingsveld in de pull-aanvraag vooraf in te vullen.
U kunt deze beschrijving desgewenst bewerken of aan deze beschrijving toevoegen en extra pull-aanvraagsjablonen toevoegen door deze te selecteren in de vervolgkeuzelijst Een sjabloon toevoegen .
Notitie
Wanneer een standaard- of vertakkingsspecifieke pull-aanvraagsjabloon automatisch wordt toegepast, vervangt deze de standaarddoorvoeringsberichten die meestal worden gebruikt voor de standaardbeschrijving. U kunt ze weer toevoegen door Doorvoerberichten toevoegen te selecteren.
Sjablonen voor vertakkingsspecifieke pull-aanvragen
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 bestand of .md met de naam van uw vertakking. De naam moet overeenkomen met het eerste niveau van de naam van de vertakking, zoals main, dev, releaseof feature. Elke vertakkingsspecifieke pull-aanvraagsjabloon wordt toegepast wanneer een pull-aanvraag zich richt op die vertakking of vertakkingen die eronder zijn opgenomen. De pull-aanvraagsjabloon met de naam feature.md wordt bijvoorbeeld toegepast als een pull-aanvraag gericht is op de feature vertakking of feature/* vertakkingen.
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
.azuredevopsdie zich in de hoofdmap van de opslagplaats bevindt - Een map met de naam
.vstsdie zich in de hoofdmap van de opslagplaats bevindt - Een map met de naam
docsdie zich in de hoofdmap van de opslagplaats bevindt - De hoofdmap van de opslagplaats
Een vertakkingsspecifieke pull-aanvraagsjabloon die moet worden toegepast op alle pull-aanvragen in de vertakking, krijgt bijvoorbeeld de dev 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 standaardsjablonen voor pull-aanvragen worden er meerdere locaties geboden om u flexibiliteit te bieden waar u sjablonen voor vertakkingsspecifieke pull-aanvragen opslaat. Wanneer een pull-aanvraag wordt gemaakt, doorzoekt Azure Opslagplaatsen de aangewezen mappen in de volgorde die is opgegeven voor een vertakkingsspecifieke pull-aanvraagsjabloon en wordt de eerste gebruikt die wordt gevonden die overeenkomt met de naam van de vertakking. Als er geen vertakkingsspecifieke pull-aanvraagsjabloon wordt gevonden, zoekt Azure Opslagplaatsen vervolgens naar een standaardsjabloon voor pull-aanvragen, zoals beschreven in de vorige sectie Standaardsjablonen voor pull-aanvragen .
Aanvullende sjablonen voor pull-aanvragen
Naast de standaard- en vertakkingsspecifieke pull-aanvraagsjablonen kunt u extra sjablonen voor pull-aanvragen configureren. Dit kunnen bestanden zijn .md die .txt 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 wordt aangegeven door het standaardbericht dat wordt vermeld 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 dedev.mdvertakkingsspecifieke sjabloon in deze pull-aanvraag. Hoewel deze niet standaard is toegevoegd, kan het nog steeds worden toegepast door het te selecteren in de lijst.
Selecteer de naam van de gewenste extra sjabloon om de inhoud toe te voegen aan de beschrijving van de huidige pull-aanvraag.
Notitie
U kunt een pull-aanvraagsjabloon opgeven om een overeenkomende standaard- of vertakkingsspecifieke pull-aanvraag te overschrijven door toe te voegen ?template=name.md aan de querytekenreeks.