Abrir e descrever um PR
Você escreveu a mudança, rodou os testes, e o diff parece limpo. Agora você precisa abrir um PR — mas um título de uma linha como "fix bug" não dá ao revisor nada para começar. Uma boa descrição de PR não repete o que o diff já mostra — ela explica o porquê: o que motivou a mudança, como verificar q
Uma boa descrição é como um bilhete que você deixa para uma babá: escrever 'cuide da criança' não é suficiente — você precisa explicar por que a rotina de hoje é diferente e como checar que está tudo bem antes de dormir.
- descrição de PR
- O texto que acompanha um Pull Request e explica ao revisor por que a mudança foi feita, como testá-la, e qual é o risco — não apenas uma repetição do que o diff já mostra.
- template de PR
- Um ficheiro fixo no repositório (por exemplo .github/pull_request_template.md) que determina quais seções devem aparecer em toda descrição de PR, para que todo mundo preencha a mesma informação.
- PR em Draft
- Um PR aberto em estado Draft — visível para a equipa e que roda verificações, mas não sinaliza 'pronto para revisão completa' até que seja marcado como Ready for review.
- pronto para revisão (Ready for review)
- A ação que transforma um PR em Draft num estado que pede ativamente a atenção completa de um revisor — o sinal de que o trabalho está pronto, não só visível.
