Skip to content

Commit 49446dc

Browse files
MaxwbhMaxwbh
authored
Correção da documentação
Correção da documentação
2 parents c063b95 + 790c00f commit 49446dc

26 files changed

+3613
-16
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
name: Bug Report
3+
about: Reporte um bug para nos ajudar a melhorar
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## 🐛 Descrição do Bug
10+
11+
Uma descrição clara e concisa do que o bug é.
12+
13+
## 🔄 Passos para Reproduzir
14+
15+
1. Faça requisição para '...'
16+
2. Com parâmetros '...'
17+
3. Veja o erro '...'
18+
19+
## ✅ Comportamento Esperado
20+
21+
Uma descrição clara do que você esperava que acontecesse.
22+
23+
## ❌ Comportamento Atual
24+
25+
Uma descrição clara do que acontece atualmente.
26+
27+
## 📋 Informações do Ambiente
28+
29+
**API:**
30+
- Versão: [ex: 1.0.0] (veja arquivo `VERSION`)
31+
- Ambiente: [ex: Docker, local, Render]
32+
- Ruby: [ex: 3.1.2]
33+
34+
**Cliente (se aplicável):**
35+
- Cliente Python versão: [ex: 1.0.0]
36+
- Python: [ex: 3.11.0]
37+
- OS: [ex: Ubuntu 22.04, macOS 13.0]
38+
39+
**Banco:**
40+
- Banco afetado: [ex: Banco do Brasil (001), Sicoob (756)]
41+
42+
## 📄 Logs
43+
44+
<details>
45+
<summary>Logs de erro (clique para expandir)</summary>
46+
47+
```
48+
Cole os logs aqui
49+
```
50+
51+
</details>
52+
53+
## 💾 Exemplo de Requisição
54+
55+
<details>
56+
<summary>Dados da requisição (clique para expandir)</summary>
57+
58+
```python
59+
# Cole o código ou curl aqui
60+
import requests
61+
62+
response = requests.get(
63+
"http://localhost:9292/api/boleto/data",
64+
params={
65+
"bank": "banco_brasil",
66+
"data": {...}
67+
}
68+
)
69+
```
70+
71+
</details>
72+
73+
## 📸 Screenshots
74+
75+
Se aplicável, adicione screenshots para ajudar a explicar seu problema.
76+
77+
## 🔍 Contexto Adicional
78+
79+
Adicione qualquer outro contexto sobre o problema aqui.
80+
81+
## ✔️ Checklist
82+
83+
- [ ] Verifiquei que não há issue similar aberta
84+
- [ ] Testei com a versão mais recente
85+
- [ ] Li a [documentação](../docs/)
86+
- [ ] Incluí logs de erro
87+
- [ ] Incluí dados para reproduzir o problema

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📖 Documentação
4+
url: https://github.com/Maxwbh/boleto_cnab_api/tree/main/docs
5+
about: Consulte a documentação completa antes de abrir uma issue
6+
- name: 🔒 Reportar Vulnerabilidade de Segurança
7+
url: https://github.com/Maxwbh/boleto_cnab_api/security/policy
8+
about: Por favor, reporte vulnerabilidades de segurança de forma privada
9+
- name: 💬 Discussões
10+
url: https://github.com/Maxwbh/boleto_cnab_api/discussions
11+
about: Faça perguntas e discuta ideias com a comunidade

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
name: Feature Request
3+
about: Sugira uma nova funcionalidade para este projeto
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 🚀 Descrição da Funcionalidade
10+
11+
Uma descrição clara e concisa da funcionalidade que você gostaria de ver.
12+
13+
## 💡 Problema que Resolve
14+
15+
Descreva o problema que esta funcionalidade resolve. Ex: "É frustrante quando [...]"
16+
17+
## ✨ Solução Proposta
18+
19+
Uma descrição clara de como você imagina que a funcionalidade funcionaria.
20+
21+
## 🔄 Alternativas Consideradas
22+
23+
Uma descrição clara de quaisquer soluções alternativas ou funcionalidades que você considerou.
24+
25+
## 📝 Exemplo de Uso
26+
27+
Como você usaria esta funcionalidade? Forneça exemplos de código se possível.
28+
29+
```python
30+
# Exemplo de como você imagina usando a funcionalidade
31+
from boleto_cnab_client import BoletoClient
32+
33+
client = BoletoClient('http://localhost:9292')
34+
# sua nova funcionalidade aqui
35+
```
36+
37+
## 🏦 Banco Específico
38+
39+
Esta funcionalidade é específica de algum banco?
40+
41+
- [ ] Não, é genérica
42+
- [ ] Sim, específica para: [ex: Banco do Brasil, Sicoob]
43+
44+
## 🎯 Tipo de Funcionalidade
45+
46+
- [ ] Novo endpoint na API
47+
- [ ] Suporte para novo banco
48+
- [ ] Melhoria em funcionalidade existente
49+
- [ ] Nova funcionalidade no cliente Python
50+
- [ ] Melhoria na documentação
51+
- [ ] Outro: _________
52+
53+
## 📊 Impacto
54+
55+
Quantas pessoas se beneficiariam desta funcionalidade?
56+
57+
- [ ] Apenas eu
58+
- [ ] Alguns usuários (< 10%)
59+
- [ ] Muitos usuários (10-50%)
60+
- [ ] Maioria dos usuários (> 50%)
61+
- [ ] Não sei
62+
63+
## 🔧 Complexidade Estimada
64+
65+
Qual você acha que seria a complexidade de implementar isso?
66+
67+
- [ ] Pequena (< 1 dia)
68+
- [ ] Média (1-3 dias)
69+
- [ ] Grande (> 3 dias)
70+
- [ ] Não sei
71+
72+
## 📚 Recursos Adicionais
73+
74+
Adicione quaisquer links, referências ou mockups que ajudem a entender sua sugestão.
75+
76+
## ✔️ Checklist
77+
78+
- [ ] Verifiquei que não há feature request similar
79+
- [ ] Li a [documentação](../docs/) completa
80+
- [ ] Esta funcionalidade está alinhada com os objetivos do projeto
81+
- [ ] Estou disposto a contribuir com a implementação (se souber como)
82+
83+
## 💬 Contexto Adicional
84+
85+
Adicione qualquer outro contexto ou screenshots sobre a feature request aqui.

‎.github/README.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# GitHub Configuration
2+
3+
Este diretório contém configurações específicas do GitHub para o projeto Boleto CNAB API.
4+
5+
## 📁 Estrutura
6+
7+
```
8+
.github/
9+
├── ISSUE_TEMPLATE/
10+
│ ├── bug_report.md # Template para reportar bugs
11+
│ ├── feature_request.md # Template para sugerir funcionalidades
12+
│ └── config.yml # Configuração de issues
13+
└── README.md # Este arquivo
14+
```
15+
16+
## 🐛 Templates de Issues
17+
18+
### Bug Report
19+
20+
Usado para reportar problemas no código, API ou documentação.
21+
22+
**Quando usar:**
23+
- API retorna erro inesperado
24+
- Cliente Python não funciona corretamente
25+
- Documentação está incorreta
26+
- Comportamento diferente do esperado
27+
28+
**Não usar para:**
29+
- Dúvidas sobre como usar (use Discussions)
30+
- Vulnerabilidades de segurança (use SECURITY.md)
31+
- Sugestões de melhorias (use Feature Request)
32+
33+
### Feature Request
34+
35+
Usado para sugerir novas funcionalidades.
36+
37+
**Quando usar:**
38+
- Adicionar suporte para novo banco
39+
- Novo endpoint na API
40+
- Melhoria no cliente Python
41+
- Nova funcionalidade útil
42+
43+
**Não usar para:**
44+
- Bugs (use Bug Report)
45+
- Mudanças que quebram compatibilidade sem necessidade
46+
- Funcionalidades muito específicas para seu caso de uso
47+
48+
## 💬 Discussões vs Issues
49+
50+
**Use Issues quando:**
51+
- Encontrou um bug confirmado
52+
- Tem uma proposta específica de funcionalidade
53+
- Quer reportar algo que precisa ser corrigido
54+
55+
**Use Discussions quando:**
56+
- Tem dúvidas sobre como usar
57+
- Quer feedback sobre uma ideia
58+
- Quer compartilhar seu caso de uso
59+
- Precisa de ajuda para resolver um problema
60+
61+
## 🔒 Segurança
62+
63+
Para reportar vulnerabilidades de segurança, **NÃO** use issues públicas.
64+
65+
Siga as instruções em [SECURITY.md](../SECURITY.md).
66+
67+
## 🤝 Contribuindo
68+
69+
Antes de abrir uma issue:
70+
71+
1. ✅ Pesquise por issues similares
72+
2. ✅ Leia a [documentação](../docs/)
73+
3. ✅ Consulte o [guia de contribuição](../CONTRIBUTING.md)
74+
4. ✅ Use o template apropriado
75+
76+
---
77+
78+
**Obrigado por contribuir com o Boleto CNAB API!**

‎.gitignore‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,113 @@
22
*~
33
*.swp
44

5+
# Ruby
6+
*.gem
7+
*.rbc
8+
/.config
9+
/coverage/
10+
/InstalledFiles
11+
/pkg/
12+
/spec/reports/
13+
/spec/examples.txt
14+
/test/tmp/
15+
/test/version_tmp/
16+
/tmp/
17+
.bundle/
18+
vendor/bundle
19+
20+
# Ruby version management
21+
.ruby-version
22+
.ruby-gemset
23+
24+
# RSpec
25+
.rspec_status
26+
27+
# Python
28+
__pycache__/
29+
*.py[cod]
30+
*$py.class
31+
*.so
32+
.Python
33+
build/
34+
develop-eggs/
35+
dist/
36+
downloads/
37+
eggs/
38+
.eggs/
39+
lib/
40+
lib64/
41+
parts/
42+
sdist/
43+
var/
44+
wheels/
45+
*.egg-info/
46+
.installed.cfg
47+
*.egg
48+
MANIFEST
49+
pip-log.txt
50+
pip-delete-this-directory.txt
51+
.pytest_cache/
52+
.coverage
53+
htmlcov/
54+
*.cover
55+
.hypothesis/
56+
57+
# Virtual environments
58+
venv/
59+
ENV/
60+
env/
61+
.venv
62+
63+
# IDEs
64+
.vscode/
65+
.idea/
66+
*.sublime-project
67+
*.sublime-workspace
68+
.project
69+
.settings/
70+
*.iml
71+
72+
# OS
73+
.DS_Store
74+
.DS_Store?
75+
._*
76+
.Spotlight-V100
77+
.Trashes
78+
ehthumbs.db
79+
Thumbs.db
80+
81+
# Logs
82+
*.log
83+
logs/
84+
*.log.*
85+
86+
# Temporary files
87+
*.tmp
88+
*.temp
89+
.cache/
90+
91+
# Docker
92+
.dockerignore.bak
93+
94+
# Environment variables
95+
.env
96+
.env.local
97+
.env.*.local
98+
99+
# Generated PDFs (exemplos)
100+
boleto*.pdf
101+
*.pdf
102+
*.jpg
103+
*.png
104+
*.tif
105+
106+
# CNAB files
107+
*.rem
108+
*.ret
109+
110+
# Backup do CHANGELOG
111+
CHANGELOG.md.bak
112+
113+
# Node modules (se houver frontend)
114+
node_modules/

0 commit comments

Comments
 (0)