Escreva uma descrição de PR que um revisor possa usar
Objetivo: permitir que um revisor decida em dois minutos o que olhar, e que um futuro leitor entenda por que a mudança existe.
Coletar
- Encontre a branch base e execute
git log --oneline <base>..HEADegit diff --stat <base>...HEAD, depois leia o diff. - Procure pelo motivo: número de issue ou ticket vinculado nos commits ou no nome da branch, a solicitação do usuário, comentários adicionados no diff. Se o motivo não estiver em nenhum desses lugares, pergunte ao usuário; não invente uma motivação.
- Verifique o que foi testado: arquivos de teste no diff e comandos que o usuário executou. Se os testes não foram executados, diga isso claramente.
- Procure por um
.github/pull_request_template.mdouPULL_REQUEST_TEMPLATE. Se existir um, preencha-o em vez de usar a estrutura abaixo.
Estrutura
<Título: imperativo, menos de 70 caracteres, nomeia a mudança de comportamento, não os arquivos>
## Por que
<O problema ou solicitação, em 1 a 3 frases. Vincule a issue se houver uma.>
## O que mudou
- <Itens de nível de comportamento agrupados por área, não uma lista de arquivos.>
## Como revisar
- Comece por <arquivo ou área>; o restante flui a partir daí.
- Parte arriscada: <a parte com maior probabilidade de estar errada e por que>.
- Não alterado propositalmente: <qualquer coisa que um revisor pode esperar e não encontrará>.
## Testes
- <Comandos exatos executados e resultados.>
- <Passos manuais e o que foi observado. "Não testado: ..." se aplicável.>
## Rollout / risco
<Migrações, configuração, feature flags, compatibilidade, como reverter. "Nenhum" somente se for verdade.>
Regras
- Descreva o que o diff faz, não o que você gostaria que ele fizesse. Releia o diff após rascunhar e remova qualquer afirmação que ele não suporte.
- Não liste todos os arquivos. Liste mudanças de comportamento, nova configuração, novas dependências e código removido.
- Sem enrolação ("Este PR tem como objetivo..."). Sem emojis, a menos que o repositório os use.
- Capturas de tela ou exemplos de saída: diga onde um ajudaria; nunca descreva uma captura de tela que você não viu.
- Produza o título e o corpo em um bloco de código para que possam ser copiados. Não execute
gh pr createa menos que seja solicitado.