CONTRIBUTING.md

Guia de Contribuição

Obrigado por considerar contribuir com o Simulador Avançado de Aposentadoria! 🎉

📋 Índice

1. Código de Conduta
2. Como Posso Contribuir?
3. Reportando Bugs
4. Sugerindo Melhorias
5. Processo de Pull Request
6. Estilo de Código

📜 Código de Conduta

Este projeto e todos os participantes estão sob o nosso Código de Conduta. Ao contribuir, você concorda em respeitá-lo.

🤝 Como Posso Contribuir?

Existem várias maneiras de contribuir com o projeto:

1. Reportando Bugs
2. Sugerindo Melhorias
3. Melhorando a Documentação
4. Contribuindo com Código
5. Revisando Pull Requests

🐛 Reportando Bugs

Antes de criar um bug report, por favor:

1. Verifique a lista de issues para ver se o bug já foi reportado
2. Atualize para a versão mais recente do código
3. Determine se o problema é realmente um bug e não um erro de configuração

Ao reportar um bug, inclua:

• Título claro e descritivo
• Passos detalhados para reproduzir o problema
• Comportamento esperado vs comportamento atual
• Screenshots (se aplicável)
• Versões do Python e das bibliotecas utilizadas
• Sistema operacional e versão

💡 Sugerindo Melhorias

Para sugerir melhorias:

1. Use um título claro e descritivo
2. Forneça uma descrição detalhada da melhoria sugerida
3. Explique por que essa melhoria seria útil
4. Inclua exemplos de como a melhoria funcionaria

🔄 Processo de Pull Request

1. Fork o repositório
2. Clone seu fork localmente
3. Crie uma nova branch para suas alterações:

   git checkout -b feature/nome-da-feature

4. Faça suas alterações
5. Execute os testes (se disponíveis)
6. Commit suas mudanças:

   git commit -m "Descrição clara da mudança"

7. Push para seu fork:

   git push origin feature/nome-da-feature

8. Abra um Pull Request

Checklist do Pull Request

• Código segue o estilo do projeto
• Testes foram adicionados/atualizados (se aplicável)
• Documentação foi atualizada
• Commits estão bem organizados e com mensagens claras

🎨 Estilo de Código

Python

• Siga o PEP 8
• Use type hints quando possível
• Documente funções e classes usando docstrings
• Mantenha funções pequenas e focadas
• Use nomes descritivos para variáveis e funções

Streamlit

• Organize os elementos da interface de forma lógica
• Use comentários para separar seções diferentes
• Mantenha a consistência no estilo visual
• Adicione mensagens de ajuda (tooltips) em campos importantes

Git

• Use mensagens de commit claras e descritivas
• Mantenha commits focados em uma única mudança
• Rebase sua branch antes do PR se necessário

📚 Recursos Adicionais

• Documentação do Streamlit
• Documentação do Plotly
• Guia de Estilo Python

❓ Dúvidas?

Se você tiver alguma dúvida sobre como contribuir, sinta-se à vontade para:

1. Abrir uma issue
2. Enviar um email para [email protected]

---

Agradecemos sua contribuição!