Como escrever a descrição de um pull request em inglês
O título de um pull request em inglês usa o verbo no imperativo e diz o que muda: "Add retry to payment webhook". A descrição responde três coisas: o que mudou (what), por quê (why) e como testar (how to test). Pull request, ou PR, é o pedido para juntar seu código à branch principal.
Exemplos
Add retry to payment webhook
Adiciona nova tentativa ao webhook de pagamento
título
Fix crash when the cart is empty
Corrige erro quando o carrinho está vazio
título
This PR adds a retry with backoff so we stop losing payment events when the provider times out.
Este PR adiciona nova tentativa com espera para pararmos de perder eventos de pagamento quando o provedor demora.
descrição
Modelo de descrição
What: Adds a retry with exponential backoff to the payment webhook.
Why: We lost 0.5% of events last week when the provider timed out.
How to test: Run the webhook tests, or trigger a timeout in staging with the mock flag.
Notes: No database changes.
Verbos para títulos
| Verbo | Uso |
|---|---|
| Add | algo novo |
| Fix | correção de bug |
| Update | mudança em algo existente |
| Remove | tirar código ou recurso |
| Refactor | reorganizar sem mudar o comportamento |
| Bump | subir a versão de uma dependência |
Erros comuns
Added new feature of login
Add Google login
Título no imperativo e específico; "new feature of" não diz nada.
Correction of the bug
Fix crash on empty cart
Use o verbo "fix" e diga qual bug.
Você entendeu?
Perguntas frequentes
Pull request ou merge request?
É a mesma ideia: GitHub chama de pull request; GitLab chama de merge request.