Etiqueta de Issues e PRs
O repositório não precisa de um processo elaborado. Ele precisa de um processo legível.Issues
Boas issues são específicas o suficiente para que outro contribuidor consiga agir sobre elas sem precisar adivinhar o problema. Inclua:- qual comportamento está errado ou faltando
- onde ele aparece
- se é comportamento atual ou desvio de documentação em relação ao estado-alvo
- passos de reprodução, quando relevante
- screenshots ou exemplos de payload quando eles ajudarem de forma significativa
- pedidos vagos de “melhorar X”
- combinar vários bugs não relacionados em uma única issue
- relatar ideias de estado-alvo como se fossem regressões
Pull requests
Bons pull requests tornam o review barato. Inclua:- um resumo curto do que mudou
- por que a mudança é necessária
- testes adicionados ou afetados
- documentação atualizada
- lacunas conhecidas ou trabalho de acompanhamento
Etiqueta de review
- mantenha os comentários de review concretos e técnicos
- questione premissas, não pessoas
- aponte desvios de comportamento e documentação faltante o quanto antes
- prefira referências exatas de arquivo/caminho a afirmações genéricas
- se uma mudança expandir o escopo no meio do caminho, divida-a
Expectativas para maintainers
- feche o loop sobre o feedback de review
- marque trabalho de acompanhamento explicitamente, em vez de escondê-lo
- não faça merge de trabalho que muda comportamento com checks vermelhos
- mantenha a documentação alinhada ao estado atual do repositório