Förbättra beskrivningar av pull-begäranden med hjälp av mallar

  • Artikel

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

Att skriva bra beskrivningar av pull-begäranden är ett bra sätt att hjälpa granskare att veta vad de kan förvänta sig när de granskar kod. De är också ett bra sätt att spåra saker som bör göras för varje ändring, till exempel testning, tillägg av enhetstester och uppdatering av dokumentation. Mallar för pull-begäranden kan hjälpa dina utvecklare att skapa bra beskrivningar av pull-begäranden som uppfyller organisationens standarder.

Den här artikeln visar hur du kommer igång med mallar för pull-begäranden.

Anteckning

Mallar för pull-begäranden kan ge vägledning, men är endast rådgivande. Använd förgreningsprinciper för att framtvinga metodtips som att kräva pull-begäranden för nyckelgrenar som main, kräva en lyckad version och framtvinga nödvändiga granskare. Mer information finns i förgreningsprinciper.

Vad är en mall för pull-begäranden?

En mall för pull-begäranden är en fil som innehåller Markdown-text som läggs till i beskrivningen av pull-begäran när pull-begäran skapas.

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

Med Azure Repos kan du skapa följande typ av mallar för pull-begäranden:

  • En standardmall för pull-begäranden som tillämpas automatiskt för alla nya pull-begäranden på lagringsplatsen, såvida den inte åsidosätts av en grenspecifik pull-begärandemall
  • Grenspecifika pull-begärandemallar som tillämpas automatiskt på pull-begäranden för en specifik gren
  • Ytterligare mallar för pull-begäranden som kan läggas till av skaparen av pull-begäran

Typen av pull-begärandemall bestäms av dess filnamn och mappplats, enligt beskrivningen i följande avsnitt. Filnamnen och mappplatserna är inte skiftlägeskänsliga, men de måste finnas i standardgrenen för din lagringsplats.

Anteckning

Alla mallfiler för pull-begäranden måste finnas i standardgrenen (vanligtvis huvudgrenen) för din lagringsplats. Endast pull-begärandemallfiler från standardgrenen används.

Standardmallar för pull-begäranden

Standardmallar för pull-begäranden tillämpas automatiskt på beskrivningsfältet när en ny pull-begäran skapas. Om du vill konfigurera din lagringsplats med en standardmall för pull-begäranden skapar du en fil med namnet pull_request_template.md eller pull_request_template.txt och sparar den i standardgrenen för din lagringsplats i någon av följande mappar.

  • En mapp med namnet .azuredevops som finns i lagringsplatsens rotmapp
  • En mapp med namnet .vsts som finns i lagringsplatsens rotmapp
  • En mapp med namnet docs som finns i lagringsplatsens rotmapp
  • Lagringsplatsens rotmapp

Flera platser tillhandahålls för att ge dig flexibilitet i var du lagrar dina mallar för pull-begäranden. När en pull-begäran skapas söker Azure Repos igenom de angivna mapparna i den angivna ordningen och använder den första standardmallen för pull-begäranden som hittas.

När en ny pull-begäran skapas i lagringsplatsen, såvida inte en grenspecifik pull-begärandemall gäller, används innehållet i standardmallen för pull-begäranden för att fylla i beskrivningsfältet i pull-begäran.

Standardmall för pull-begäranden

Du kan redigera eller lägga till i den här beskrivningen och lägga till ytterligare pull-begärandemallar om du vill genom att välja dem i listrutan Lägg till en mall .

Anteckning

När en standardmall eller grenspecifik pull-begärandemall tillämpas automatiskt ersätter den de standardincheckningsmeddelanden som vanligtvis används för standardbeskrivningen. Du kan lägga till dem igen genom att välja Lägg till incheckningsmeddelanden.

Grenspecifika mallar för pull-begäranden

Grenspecifika pull-begärandemallar kan konfigureras för pull-begäranden som riktar sig till en specifik gren. Om du vill konfigurera din lagringsplats med en grenspecifik pull-begärandemall skapar du en .txt eller .md -fil med namnet efter din gren. Namnet måste matcha den första nivån i grennamnet, till exempel main, dev, releaseeller feature. Varje grenspecifik pull-begärandemall tillämpas varje gång en pull-begäran riktar sig mot den grenen eller eventuella grenar som finns under den. Till exempel tillämpas pull-begärandemallen med namnet feature.md om en pull-begäran riktar sig mot grenen feature eller några feature/* grenar.

Mallar för grenspecifika pull-begäranden måste sparas i standardgrenen för din lagringsplats med hjälp av följande mapphierarki: pull_request_template/branches/. Dessa mappar måste vara baserade i någon av följande mappar på din lagringsplats.

  • En mapp med namnet .azuredevops som finns i lagringsplatsens rotmapp
  • En mapp med namnet .vsts som finns i lagringsplatsens rotmapp
  • En mapp med namnet docs som finns i lagringsplatsens rotmapp
  • Lagringsplatsens rotmapp

Till exempel skulle en grenspecifik pull-begärandemall som ska gälla för alla pull-begäranden till grenen dev namnges dev.md eller dev.txt och finnas på någon av följande platser.

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

Precis som standardmallar för pull-begäranden tillhandahålls flera platser för att ge dig flexibilitet i var du lagrar grenspecifika pull-begärandemallar. När en pull-begäran skapas söker Azure Repos igenom de avsedda mapparna i den ordning som anges för en grenspecifik pull-begärandemall och använder den första som den hittar som matchar grennamnet. Om ingen grenspecifik pull-begärandemall hittas söker Azure Repos efter en standardmall för pull-begäranden enligt beskrivningen i föregående avsnitt med standardmallar för pull-begäranden .

Grenspecifik pull-begärandemall

Ytterligare mallar för pull-begäranden

Förutom standardmallarna och grenspecifika pull-begäranden kan du konfigurera ytterligare mallar för pull-begäranden. Dessa kan vara .md eller .txt filer som finns i någon av följande mappar i din standardgren.

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

När en pull-begäran skapas kan du lägga till någon av de tillgängliga mallarna för pull-begäranden genom att välja dem i listrutan Lägg till en mall . Namnen i listrutan baseras på filnamnen för mallarna.

I följande exempel visas tre mallar.

  • dev.md – Det här är den grenspecifika mall som tillämpades som standard på den här pull-begäran till utvecklingsgrenen, vilket anges av standardmeddelandet som visas efter filnamnet.
  • additional.md - Det här är ytterligare en mall.
  • pull_request_template.md – Det här är normalt standardmallen, men den åsidosätts av den dev.md grenspecifika mallen i den här pull-begäran. Även om den inte har lagts till som standard kan den fortfarande tillämpas genom att välja den i listan.

Ytterligare mall för pull-begäranden

Välj namnet på den önskade ytterligare mallen för att lägga till innehållet i den aktuella beskrivningen av pull-begäran.

Ytterligare mall för pull-begäran tillagd

Anteckning

Du kan ange en mall för pull-begäranden som åsidosätter matchande standard- eller grenspecifika pull-begäranden genom att lägga ?template=name.md till i frågesträngen.

Se även