Migliorare le descrizioni delle richieste pull usando i modelli

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

La scrittura di descrizioni di richieste pull valide è un ottimo modo per aiutare i revisori a sapere cosa aspettarsi durante la revisione del codice. Sono anche un ottimo modo per tenere traccia delle operazioni che devono essere eseguite per ogni modifica, ad esempio i test, l'aggiunta di unit test e l'aggiornamento della documentazione. I modelli di richiesta pull consentono agli sviluppatori di creare descrizioni di richieste pull eccezionali che soddisfano gli standard dell'organizzazione.

Questo articolo illustra come iniziare a usare i modelli di richiesta pull.

Nota

I modelli di richiesta pull possono fornire indicazioni, ma sono solo consultivi. Usare i criteri del ramo per applicare le migliori pratiche, ad esempio rendere obbligatorie le pull request per rami chiave come main, richiedere un esito positivo della compilazione e applicare i revisori necessari. Per altre informazioni, vedere branch policies.

Prerequisiti

Categoria	Requisiti
Accesso al progetto	Membro di un progetto.
Autorizzazioni	- Visualizzare il codice nei progetti privati: almeno accesso livello Basic . - Clonare o contribuire al codice nei progetti privati: membro del gruppo di sicurezza dei collaboratori o con le autorizzazioni corrispondenti nel progetto. - Impostare le autorizzazioni per il ramo o il repository: Gestisci le autorizzazioni per il ramo o il repository. - Modificare il ramo predefinito: Modificare le politiche le autorizzazioni per il repository. - Importare un repository: membro del gruppo di sicurezza amministratori del progetto o del gruppo di sicurezza Git a livello di progetto Crea repository impostato su Consenti. Per altre informazioni, vedere Impostare le autorizzazioni del repository Git.
Servizi	Repos abilitato.
Strumenti	Opzionale. Usare comandi az repos: interfaccia della riga di comando di Azure DevOps.

Nota

Nei progetti pubblici, gli utenti con l'accesso degli stakeholder hanno accesso completo ad Azure Repos, inclusa la visualizzazione, la clonazione e il contributo al codice.

Che cos'è un modello di richiesta pull?

Un modello di richiesta pull è un file contenente Markdown testo aggiunto alla descrizione della richiesta pull quando viene creata la richiesta pull.

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 consente di creare il tipo di modelli di richiesta pull seguenti:

• Un modello di pull request predefinito applicato automaticamente per tutte le nuove pull request nel repository, a meno che non venga sovrascritto da un modello di pull request specifico per un ramo.
• Modelli specifici per branch di pull request che vengono applicati automaticamente alle pull request destinate a un ramo specifico
• Modelli di richiesta pull aggiuntivi che possono essere aggiunti facoltativamente dall'autore della richiesta pull

Il tipo di modello di richiesta pull è determinato dal nome file e dal percorso della cartella, come illustrato nelle sezioni seguenti. I nomi file e i percorsi delle cartelle non fanno distinzione tra maiuscole e minuscole, ma devono trovarsi nel ramo predefinito del repository.

Nota

Tutti i file modello di richiesta pull devono trovarsi nel ramo predefinito (in genere principale) del repository. Vengono usati solo i modelli di richieste pull dal ramo predefinito.

Modelli di richiesta pull predefiniti

I modelli di richiesta pull predefiniti vengono applicati automaticamente al campo di descrizione quando viene creata una nuova richiesta pull. Per configurare il repository con un modello di richiesta pull predefinito, creare un file denominato pull_request_template.md o pull_request_template.txt e salvarlo nel ramo predefinito del repository in una delle cartelle seguenti.

• Cartella denominata .azuredevops contenuta nella cartella radice del repository
• Cartella denominata .vsts contenuta nella cartella radice del repository
• Cartella denominata docs contenuta nella cartella radice del repository
• Cartella radice del repository

Sono disponibili più posizioni per offrire flessibilità nella posizione in cui archiviare i modelli di richiesta pull. Quando viene creata una richiesta pull, Azure Repos cerca le cartelle designate nell'ordine specificato e usa il primo modello di richiesta pull predefinito trovato.

Quando viene creata una nuova richiesta pull nel repository, a meno che non venga applicato un modello di richiesta pull specifico del ramo , il contenuto del modello di richiesta pull predefinito viene usato per precompilare il campo di descrizione nella richiesta pull.

È possibile modificare questa descrizione o aggiungere modelli di richiesta pull aggiuntivi , se lo si desidera, selezionandoli dal menu a tendina Aggiungi un modello .

Nota

Quando viene applicato automaticamente un modello di richiesta pull predefinito o specifico del ramo, sostituisce i messaggi di commit standard usati in genere per la descrizione predefinita. È possibile aggiungerli di nuovo selezionando Aggiungi messaggi di commit.

Modelli di richiesta pull specifici del ramo

I modelli di richiesta pull specifici del ramo possono essere configurati per le richieste pull destinate a un ramo specifico. Per configurare il repository con un modello di richiesta pull specifico del ramo, creare un file .txt o .md che porta il nome del tuo ramo. Il nome deve corrispondere al primo livello del nome del ramo, ad esempio main, dev, releaseo feature. Ogni modello di richiesta pull del ramo specifico viene applicato ogni volta che una richiesta pull sia diretta a quel ramo o a qualsiasi ramo in esso contenuto. Ad esempio, il modello di richiesta pull denominato feature.md verrà applicato se una richiesta pull ha come destinazione il ramo feature o qualsiasi ramo feature/*.

I modelli di pull request specifici per ramo devono essere salvati nel ramo predefinito del tuo repository usando la seguente gerarchia di cartelle: pull_request_template/branches/. Queste cartelle devono essere basate su una delle cartelle seguenti nel repository.

• Cartella denominata .azuredevops contenuta nella cartella radice del repository
• Cartella denominata .vsts contenuta nella cartella radice del repository
• Cartella denominata docs contenuta nella cartella radice del repository
• La cartella radice del repository

Ad esempio, un modello di richiesta pull specifico del ramo che deve essere applicato a tutte le richieste pull nel ramo dev sarà denominato dev.md o dev.txt e situato in una delle posizioni seguenti.

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

Proprio come i modelli di richiesta pull predefiniti, sono disponibili più posizioni per offrire flessibilità in cui archiviare modelli di richiesta pull specifici del ramo. Quando viene creata una richiesta pull, Azure Repos cerca le cartelle designate nell'ordine specificato per un modello di richiesta pull specifico del ramo e usa il primo che trova che corrisponde al nome del ramo. Se non viene trovato alcun modello di richiesta pull specifico del ramo, Azure Repos cerca un modello di richiesta pull predefinito come descritto nella sezione precedente Modelli di richiesta pull predefiniti.

Modelli di richiesta pull aggiuntivi

Oltre ai modelli di richiesta pull predefiniti e specifici del ramo, è possibile configurare modelli di richiesta pull aggiuntivi. Possono essere .md o .txt file, che si trovano in una delle cartelle seguenti nel ramo predefinito.

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

Quando viene creata una richiesta pull, è possibile aggiungere uno dei modelli di richiesta pull disponibili scegliendoli dall'elenco a discesa Aggiungi un modello . I nomi nell'elenco a discesa sono basati sui nomi di file dei modelli.

Nell'esempio seguente sono elencati tre modelli.

• dev.md: si tratta del modello specifico del ramo applicato per impostazione predefinita a questa richiesta pull nel ramo di sviluppo, come indicato dal messaggio predefinito elencato dopo il nome file.
• additional.md: si tratta di un modello aggiuntivo.
• pull_request_template.md: si tratta in genere del modello predefinito, ma è stato sottoposto a override dal modello specifico del ramo dev.md in questa richiesta pull. Anche se non è stato aggiunto per impostazione predefinita, può comunque essere applicato selezionandolo dall'elenco.

Selezionare il nome del modello aggiuntivo desiderato per accodarne il contenuto alla descrizione della richiesta pull corrente.

Nota

È possibile specificare un modello di richiesta pull per eseguire l'override di qualsiasi richiesta pull predefinita o specifica del ramo corrispondente aggiungendo ?template=name.md alla querystring.

Vedere anche

• Creare una richiesta pull per esaminare e unire codice
• Informazioni sui rami e sui criteri dei rami