Políticas de Boas Práticas para Issues
1. Criação de Issues
- Título claro e objetivo: O título deve resumir o problema ou tarefa.
- Descrição completa: Inclua o comportamento esperado, atual, e passos para reproduzir (se for um bug).
- Exemplo: “Erro no cálculo de imposto ao finalizar compra”.
2. Organização de Issues
- Etiquetas (Labels): Use labels para categorizar (e.g.,
bug,feature,enhancement,documentation). - Milestones: Associe as issues a marcos de versão ou entregas (e.g.,
v1.0.0).
3. Atribuição de Issues
- Responsáveis: Atribua uma pessoa para cada issue. Adicione colaboradores se necessário.
4. Uso de Comentários
- Seja claro e objetivo: Discuta soluções ou forneça atualizações diretamente na issue.
- Referencie PRs: Use
Closes #123para vincular e fechar a issue automaticamente ao mesclar um PR.
5. Fechamento de Issues
- Fechamento automático: Use
Fixes #<número-da-issue>no commit ou PR para fechar a issue automaticamente. - Fechamento manual: Se a tarefa for concluída, feche a issue e explique brevemente.
6. Templates
- Use templates: Padronize a criação de issues com templates como "Bug Report" ou "Feature Request".
7. Acompanhamento
- Mantenha as issues atualizadas: Marque o progresso e ajuste as prioridades conforme necessário.
📁 Histórico de versão
| Versão | Data | Descrição | Autor |
|---|---|---|---|
| 1.0 | 11/11/2024 | Adicinando as políticas de boas issues | Marcos Vieira |