Este diretório contém configurações específicas do GitHub para o projeto Boleto CNAB API.
.github/
├── ISSUE_TEMPLATE/
│ ├── bug_report.md # Template para reportar bugs
│ ├── feature_request.md # Template para sugerir funcionalidades
│ └── config.yml # Configuração de issues
└── README.md # Este arquivo
Usado para reportar problemas no código, API ou documentação.
Quando usar:
- API retorna erro inesperado
- Cliente Python não funciona corretamente
- Documentação está incorreta
- Comportamento diferente do esperado
Não usar para:
- Dúvidas sobre como usar (use Discussions)
- Vulnerabilidades de segurança (use SECURITY.md)
- Sugestões de melhorias (use Feature Request)
Usado para sugerir novas funcionalidades.
Quando usar:
- Adicionar suporte para novo banco
- Novo endpoint na API
- Melhoria no cliente Python
- Nova funcionalidade útil
Não usar para:
- Bugs (use Bug Report)
- Mudanças que quebram compatibilidade sem necessidade
- Funcionalidades muito específicas para seu caso de uso
Use Issues quando:
- Encontrou um bug confirmado
- Tem uma proposta específica de funcionalidade
- Quer reportar algo que precisa ser corrigido
Use Discussions quando:
- Tem dúvidas sobre como usar
- Quer feedback sobre uma ideia
- Quer compartilhar seu caso de uso
- Precisa de ajuda para resolver um problema
Para reportar vulnerabilidades de segurança, NÃO use issues públicas.
Siga as instruções em SECURITY.md.
Antes de abrir uma issue:
- ✅ Pesquise por issues similares
- ✅ Leia a documentação
- ✅ Consulte o guia de contribuição
- ✅ Use o template apropriado
Obrigado por contribuir com o Boleto CNAB API!