Guia de Contribuição¶
Obrigado por considerar contribuir com o Sentiment Radar!
Este guia apresenta diretrizes para colaborar de forma clara e produtiva.
Código de Conduta¶
Todos os colaboradores devem seguir um código de conduta que promova respeito e inclusão.
Principais pontos: - Respeite outros colaboradores - Receba feedback de forma construtiva
Como Contribuir¶
Reportar Bugs¶
- Abra uma issue
- Informe:
- Título claro
- Passos para reproduzir
- Comportamento esperado e observado
- Prints (se possível)
Sugerir Melhorias¶
- Abra uma issue com sugestão de melhoria
- Descreva o problema que deseja resolver
- Explique como sua sugestão é útil
Uso de Ferramentas de IA¶
Se usar ferramentas como ChatGPT, Copilot ou Claude:
- Registre seus prompts no arquivo
ai_prompts_log.md - Atualize o documento
ai_usage.mdcom a ferramenta utilizada - Revise criticamente o código gerado
- Teste antes de submeter
Enviando Pull Requests¶
# Fork e crie um novo branch
git checkout -b feature/nova-funcionalidade
# Após alterações
git commit -m "Adiciona nova funcionalidade"
git push origin feature/nova-funcionalidade
Depois disso, abra um Pull Request no GitHub.
Padrões de Código¶
- Siga a PEP 8
- Comente funções e métodos
- Use nomes descritivos e commits claros
- Adicione testes quando possível
Ambiente de Desenvolvimento¶
# Instale dependências de desenvolvimento
pip install -r requirements-dev.txt
# Ative o ambiente virtual
python -m venv venv
source venv/bin/activate
Consulte também:
- configuration_guide.md
- README.md
Revisão de Código¶
- Seu PR será avaliado por um mantenedor
- Você poderá ser solicitado a fazer ajustes
- Uma vez aprovado, será integrado ao projeto
Contato¶
Dúvidas ou sugestões? - Abra uma issue no GitHub - Ou entre em contato diretamente pelo LinkedIn
Obrigado por contribuir!
Sua colaboração é muito valiosa!
Autor¶
Desenvolvido por Alan de Oliveira Gonçalves
GitHub | LinkedIn