Melhorar descrições de pedidos Pull com modelos
Serviços do Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019
Escrever boas descrições de pedidos Pull é uma excelente forma de ajudar os revisores a saber o que esperar ao rever código. Também são uma excelente forma de ajudar a controlar coisas que devem ser feitas para cada alteração, como testar, adicionar testes de unidades e atualizar a documentação. Os modelos de pedido Pull podem ajudar os seus programadores a criar excelentes descrições de pedidos Pull que cumprem os padrões da sua organização.
Este artigo mostra-lhe como começar a utilizar modelos de pedido Pull.
Nota
Os modelos de pedido Pull podem fornecer orientação, mas são apenas de aconselhamento. Utilize políticas de ramo para impor as melhores práticas, como exigir pedidos Pull para ramos principais, como principal, exigir uma compilação com êxito e impor os revisores necessários. Para obter mais informações, veja políticas de ramo.
O que é um modelo de pedido Pull?
Um modelo de pedido Pull é um ficheiro que contém texto markdown que é adicionado à descrição do seu pedido Pull quando o pedido Pull é criado.
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
Os Repositórios do Azure permitem-lhe criar o seguinte tipo de modelos de pedido Pull:
- Um modelo de pedido Pull predefinido que é aplicado automaticamente a todos os novos pedidos Pull no repositório, a menos que seja substituído por um modelo de pedido Pull específico de um ramo
- Ramificar modelos de pedido Pull específicos que são aplicados automaticamente a pedidos Pull destinados a um ramo específico
- Modelos de pedido Pull adicionais que podem ser adicionados opcionalmente pelo criador do pedido Pull
O tipo de modelo de pedido Pull é determinado pelo respetivo nome de ficheiro e localização da pasta, conforme abrangido nas secções seguintes. Os nomes de ficheiro e as localizações das pastas não são sensíveis a maiúsculas e minúsculas, mas têm de estar no ramo predefinido do seu repositório.
Nota
Todos os ficheiros de modelo de pedido Pull têm de estar localizados no ramo predefinido (normalmente principal) do seu repositório. São utilizados apenas ficheiros de modelo de pedido Pull do ramo predefinido.
Modelos de pedido Pull predefinidos
Os modelos de pedido Pull predefinidos são aplicados automaticamente ao campo de descrição quando é criado um novo pedido Pull. Para configurar o repositório com um modelo de pedido Pull predefinido, crie um ficheiro com o nome pull_request_template.md ou pull_request_template.txt guarde-o no ramo predefinido do seu repositório numa das seguintes pastas.
- Uma pasta com o nome
.azuredevopsque está contida na pasta raiz do repositório - Uma pasta com o nome
.vstsque está contida na pasta raiz do repositório - Uma pasta com o nome
docsque está contida na pasta raiz do repositório - A pasta raiz do repositório
São fornecidas várias localizações para lhe dar flexibilidade no local onde armazena os seus modelos de pedido Pull. Quando um pedido Pull é criado, os Repositórios do Azure pesquisam as pastas designadas pela ordem indicada e utilizam o primeiro modelo de pedido Pull predefinido que encontra.
Quando um novo pedido Pull é criado no repositório, a menos que se aplique um modelo de pedido Pull específico de um ramo, os conteúdos do modelo de pedido Pull predefinido são utilizados para preencher previamente o campo de descrição no pedido Pull.
Pode editar ou adicionar a esta descrição e acrescentar modelos de pedido Pull adicionais , se assim o desejar, ao selecioná-los na lista pendente Adicionar um modelo .
Nota
Quando um modelo de pedido Pull predefinido ou específico do ramo é aplicado automaticamente, substitui as mensagens de consolidação padrão que normalmente são utilizadas para a descrição predefinida. Pode adicioná-las novamente ao selecionar Adicionar mensagens de consolidação.
Ramificar modelos de pedido Pull específicos
Os modelos de pedido Pull específicos do ramo podem ser configurados para pedidos Pull que visam um ramo específico. Para configurar o repositório com um modelo de pedido Pull específico do ramo, crie um .txt ficheiro ou .md com o nome do ramo . O nome tem de corresponder ao primeiro nível do nome do ramo, como main, dev, releaseou feature. Cada modelo de pedido Pull específico de ramo é aplicado sempre que um pedido Pull visa esse ramo ou quaisquer ramos contidos no mesmo. Por exemplo, o modelo de pedido Pull com o nome feature.md seria aplicado se um pedido Pull visasse o feature ramo ou quaisquer feature/* ramos.
Os modelos de pedido Pull específicos do ramo têm de ser guardados no ramo predefinido do seu repositório com a seguinte hierarquia de pastas: pull_request_template/branches/. Estas pastas têm de ser baseadas numa das seguintes pastas no seu repositório.
- Uma pasta com o nome
.azuredevopsque está contida na pasta raiz do repositório - Uma pasta com o nome
.vstsque está contida na pasta raiz do repositório - Uma pasta com o nome
docsque está contida na pasta raiz do repositório - A pasta raiz do repositório
Por exemplo, um modelo de pedido Pull específico de ramo que deve ser aplicado a todos os pedidos Pull no dev ramo seria nomeado dev.md ou dev.txt e localizado numa das seguintes localizações.
<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/
Tal como os modelos de pedido Pull predefinidos, são fornecidas múltiplas localizações para lhe dar flexibilidade no local onde armazena modelos de pedido Pull específicos do ramo. Quando um pedido Pull é criado, os Repositórios do Azure pesquisam as pastas designadas pela ordem indicada para um modelo de pedido Pull específico do ramo e utilizam o primeiro que encontra que corresponde ao nome do ramo. Se não for encontrado nenhum modelo de pedido Pull específico de ramo, os Repositórios do Azure procurarão um modelo de pedido Pull predefinido, conforme descrito na secção anterior Modelos de pedido Pull predefinidos .
Modelos de pedido Pull adicionais
Além dos modelos de pedido Pull predefinidos e específicos do ramo, pode configurar modelos de pedido Pull adicionais. Estes podem ser .md ficheiros ou .txt , localizados numa das seguintes pastas no ramo predefinido.
<repository root>/.azuredevops/pull_request_template/<repository root>/.vsts/pull_request_template/<repository root>/docs/pull_request_template/<repository root>/pull_request_template/
Quando é criado um pedido Pull, pode acrescentar qualquer um dos modelos de pedido Pull disponíveis ao selecioná-los na lista pendente Adicionar um modelo . Os nomes na lista pendente baseiam-se nos nomes dos ficheiros dos modelos.
No exemplo seguinte, estão listados três modelos.
-
dev.md- Este é o modelo específico do ramo que foi aplicado por predefinição a este pedido Pull no ramo de desenvolvimento, conforme indicado pela mensagem predefinida listada após o nome de ficheiro. -
additional.md- Este é um modelo adicional. -
pull_request_template.md- Normalmente, este é o modelo predefinido, mas foi substituído pelo modelo específico dodev.mdramo neste pedido Pull. Apesar de não ter sido adicionado por predefinição, ainda pode ser aplicado ao selecioná-lo na lista.
Selecione o nome do modelo adicional pretendido para acrescentar o respetivo conteúdo à descrição atual do pedido Pull.
Nota
Pode especificar um modelo de pedido Pull para substituir qualquer pedido Pull predefinido ou específico do ramo correspondente ao acrescentar ?template=name.md à cadeia de consulta.