Vylepšení popisů žádostí o přijetí změn pomocí šablon

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Psaní vhodných popisů žádostí o přijetí změn je skvělý způsob, jak revidujícím pomoct zjistit, co očekávat při kontrole kódu. Představují také skvělý způsob, jak sledovat, co je potřeba udělat pro každou změnu, jako je testování, přidávání testů jednotek a aktualizace dokumentace. Šablony žádostí o přijetí změn můžou vývojářům pomoct vytvářet skvělé popisy žádostí o přijetí změn, které splňují standardy vaší organizace.

V tomto článku se dozvíte, jak začít se šablonami žádostí o přijetí změn.

Poznámka:

Šablony pull requestů mohou poskytnout pokyny, ale jsou pouze doporučující. Zásady větví použijte k vynucení osvědčených postupů, jako je vyžadování žádostí o přijetí změn pro klíčové větve, jako je hlavní, vyžadování úspěšného sestavení a vynucení požadovaných kontrolorů. Další informace o zásadách větve najdete v .

Požadavky

Kategorie	Požadavky
Přístup k projektu	Člen projektu.
Oprávnění	- Zobrazit kód v soukromých projektech: Alespoň Základní přístup. - Klonování nebo přispívání do kódu v soukromých projektech: Člen skupiny zabezpečení Contributors nebo osoba s odpovídajícími oprávněními v projektu. – Nastavte oprávnění pro větev nebo úložiště: Správa oprávnění oprávnění pro větev nebo úložiště. – Změnit výchozí větev: Upravit zásady oprávnění pro úložiště. – Import úložiště: Člen skupiny zabezpečení Projektoví administrátoři nebo oprávnění Vytvořit úložiště na úrovni projektu Git nastavená na Povolit. Další informace najdete v tématu Nastavení oprávnění úložiště Git.
Služby	Repozitáře povoleny.
Nástroje	Volitelný. Použijte příkazy az repos: Azure DevOps CLI.

Poznámka:

Ve veřejných projektech mají uživatelé s přístupem Stakeholder plný přístup do Azure Repos, kde mohou zobrazovat, klonovat a přispívat ke kódu.

Co je šablona pull requestu?

Šablona žádosti o přijetí změn je soubor obsahující Markdownu text, který se při vytvoření žádosti o přijetí změn přidá do popisu žádosti o přijetí změn.

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 umožňuje vytvořit následující typ šablon žádostí o přijetí změn:

• Výchozí šablona pull requestu, která se automaticky použije pro všechny nové pull requesty v úložišti, pokud ji nepřepíše šablona pull requestu specifická pro větev
• Specifické pro větev šablony žádostí o přijetí změn, které se automaticky použijí na ty, které cílí na konkrétní větev.
• Další šablony žádostí o přijetí změn, které může tvůrce žádosti přidat podle potřeby

Typ šablony žádosti o přijetí změn je určen názvem souboru a umístěním složky, jak je popsáno v následujících částech. Názvy souborů a umístění složek nerozlišují velká a malá písmena, ale musí být ve výchozí větvi vašeho repozitáře.

Poznámka:

Všechny soubory šablony žádosti o přijetí změn musí být umístěné ve výchozí větvi (obvykle hlavní) vašeho úložiště. Používají se pouze soubory z šablon pull requestů z výchozí větve.

Výchozí šablony pull requestů

Výchozí šablony žádostí o přijetí změn se automaticky použijí na pole popisu při vytvoření nové žádosti o přijetí změn. Pokud chcete nakonfigurovat úložiště s výchozí šablonou žádosti o přijetí změn, vytvořte soubor s názvem pull_request_template.md nebo pull_request_template.txt a uložte ho do výchozí větve úložiště v jedné z následujících složek.

• Složka s názvem .azuredevops, která je obsažena v kořenové složce úložiště
• Složka s názvem .vsts, která je obsažena v kořenové složce úložiště
• Složka s názvem docs, která je obsažena v kořenové složce úložiště
• Kořenová složka úložiště

K dispozici je několik umístění, která vám poskytnou flexibilitu v umístění, kam ukládáte šablony žádostí o přijetí změn. Když se vytvoří žádost o přijetí změn, Azure Repos prohledá určené složky v uvedeném pořadí a použije první výchozí šablonu žádosti o přijetí změn, kterou najde.

Pokud se v úložišti vytvoří nová žádost o přijetí změn, pokud se nepoužije šablona žádosti o přijetí změn specifická pro větve, použije se obsah výchozí šablony žádosti o přijetí změn k předběžnému naplnění pole popisu v žádosti o přijetí změn.

Pokud chcete, můžete tento popis upravit nebo přidat a přidat další šablony žádostí o přijetí změn, pokud je chcete vybrat v rozevíracím seznamu Přidat šablonu.

Poznámka:

Pokud se automaticky použije šablona žádosti o přijetí změn specifická pro konkrétní větev, nahradí standardní zprávy potvrzení, které se obvykle používají pro výchozí popis. Můžete je přidat zpět tak, že vyberete Přidat zprávy potvrzení.

Šablony žádostí o přijetí změn pro konkrétní větev

Šablony žádostí o přijetí změn pro konkrétní větev je možné nakonfigurovat pro žádosti o přijetí změn, které cílí na konkrétní větev. Pokud chcete nakonfigurovat úložiště pomocí šablony žádosti o přijetí změn pro konkrétní větev, vytvořte .txt nebo .md soubor pojmenovaný po větvi. Název musí odpovídat první úrovni názvu větve, například main, dev, releasenebo feature. Šablona pull requestu specifická pro určitou větev se použije vždy, když je pull request zaměřen na tuto větev nebo na kteroukoli z větví pod ní. Například šablona žádosti o přijetí změn s názvem feature.md by se použila v případě, že žádost o přijetí změn cílí na větev feature nebo jakékoli větve feature/*.

Šablony žádostí o přijetí změn pro konkrétní větev musí být uloženy ve výchozí větvi úložiště pomocí následující hierarchie složek: pull_request_template/branches/. Tyto složky musí být založené na jedné z následujících složek ve vašem úložišti.

• Složka s názvem .azuredevops, která je obsažena v kořenové složce úložiště
• Složka s názvem .vsts, která je obsažena v kořenové složce úložiště
• Složka s názvem docs, která je obsažena v kořenové složce úložiště
• Kořenová složka úložiště

Například šablona žádosti o přijetí změn specifická pro větev, která by se měla vztahovat na všechny žádosti o přijetí změn do větve dev, by měla mít název dev.md nebo dev.txt a umístěná v jednom z následujících umístění.

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

Stejně jako výchozí šablony žádostí o přijetí změn je k dispozici několik umístění, která vám poskytnou flexibilitu v tom, kde ukládáte šablony žádostí o přijetí změn specifické pro větev. Když se vytvoří žádost o přijetí změn, Azure Repos prohledá určené složky v pořadí určeném pro šablonu žádosti o přijetí změn pro konkrétní větev a použije první složku, kterou najde, která odpovídá názvu větve. Pokud se nenajde žádná šablona žádosti o přijetí změn specifická pro větev, Azure Repos vyhledá výchozí šablonu žádosti o přijetí změn, jak je popsáno v předchozí výchozí šablony žádostí o přijetí změn oddílu.

Další šablony žádostí o přijetí změn

Kromě šablon žádostí o přijetí změn specifických pro výchozí a větev můžete nakonfigurovat i další šablony žádostí o přijetí změn. Můžou to být .md nebo .txt soubory umístěné v jedné z následujících složek ve vaší výchozí větvi.

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

Po vytvoření žádosti o přijetí změn můžete připojit některou z dostupných šablon žádostí o přijetí změn tak, že je vyberete v rozevíracím seznamu Přidat šablonu. Názvy v rozevíracím seznamu jsou založené na názvech souborů šablon.

V následujícím příkladu jsou uvedeny tři šablony.

• dev.md – Toto je šablona specifická pro větev, která byla ve výchozím nastavení použita pro tento pull request do vývojové větve, jak ukazuje výchozí zpráva uvedená za názvem souboru.
• additional.md – jedná se o další šablonu.
• pull_request_template.md – Tato šablona je pravidelně výchozí, ale byla nahrazena šablonou specifickou pro větev dev.md v této žádosti o úpravu. I když ho ve výchozím nastavení nepřidali, můžete ho dál použít tak, že ho vyberete ze seznamu.

Vyberte název požadované další šablony a připojte jeho obsah k popisu aktuální žádosti o přijetí změn.

Poznámka:

Můžete zadat šablonu žádosti o přijetí změn, která přepíše jakoukoli odpovídající výchozí žádost nebo žádost o přijetí změn specifickou pro větev připojením ?template=name.md do řetězce dotazu.

Viz také

• Vytvoření žádosti o přijetí změn pro kontrolu a sloučení kódu
• O pobočkách a zásadách pro pobočky