Como resumir uma pull request para quem vai revisá-la
Um resumo de pull request ajuda a pessoa revisora a entender o problema, a abordagem e os pontos que merecem atenção. Ele é mais útil quando a descrição reflete as mudanças realmente fornecidas.
Comece com o material certo.
- O que você fornece
- um diff de texto expandido e o contexto da issue visível na página.
- O resultado pretendido
- Salve um resumo das alterações observadas, da motivação e dos testes realmente demonstrados pelas evidências.
Como funciona o fluxo de trabalho.
Explique o que mudou e por quê, depois identifique questões de comportamento, compatibilidade ou migração sustentadas pelo diff e pelas notas. Separe testes executados de testes apenas sugeridos.
O que conferir no resultado.
Compare o resumo com os arquivos alterados antes de publicar. Não afirme que um teste passou ou que um risco foi eliminado, a menos que as evidências fornecidas comprovem esse resultado.
Visualize o Markdown para conferir títulos, listas e links, além do texto. Mantenha as referências junto do documento para que um revisor possa rastrear afirmações importantes até o material fornecido.
Aprenda com o exemplo resolvido.
O exemplo Markdown para download mostra uma possível organização do resultado. Leia-o junto do exemplo de origem e distinga fatos registrados, redação proposta e perguntas ainda sem resposta.
O exemplo fornecido é ilustrativo. Não é uma execução registrada com seus dados.
Baixe o exemplo ↓Use com seu próprio material.
- Abra a fonte com a qual quer trabalhar e ative o WebAct nessa aba.
- Copie a tarefa da seção principal, acrescente os campos ou preferências necessários e revise as ações propostas.
- Compare o primeiro resultado com a fonte. Peça uma correção ou um ajuste específico quando necessário.