Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (82 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

110 lines (82 loc) · 3.07 KB

Contribuindo para o ColabLLM

Obrigado por considerar contribuir com o ColabLLM! Valorizamos muito sua participação.

Como Contribuir

Reportando Bugs

Se você encontrar um bug, por favor abra uma issue incluindo:

  • Descrição clara do problema
  • Passos para reproduzir
  • Comportamento esperado vs. comportamento atual
  • Logs relevantes (remova informações sensíveis)
  • Ambiente (GPU, versão do Python, etc.)

Sugerindo Melhorias

Sugestões são bem-vindas! Ao propor uma nova funcionalidade:

  • Explique o caso de uso
  • Descreva o comportamento desejado
  • Considere impactos em performance e compatibilidade

Pull Requests

  1. Fork o repositório e crie uma branch a partir de main

    git checkout -b feature/minha-funcionalidade

  2. Siga as diretrizes de código:

    • Código Python deve seguir PEP 8
    • Adicione docstrings para funções e classes
    • Mantenha as variáveis de configuração no topo do arquivo
    • Evite hardcoding de valores - use variáveis de ambiente

  3. Teste suas alterações:

    • Execute o código no Google Colab
    • Teste com diferentes modelos
    • Verifique se a autenticação funciona corretamente
    • Valide o streaming de respostas

  4. Faça commit das alterações:

    git commit -m "feat: adiciona suporte para novos modelos"

    Siga o padrão de commits:

    • feat: Nova funcionalidade
    • fix: Correção de bug
    • docs: Alterações na documentação
    • refactor: Refatoração de código
    • perf: Melhorias de performance
    • test: Adição ou correção de testes
    • chore: Tarefas de manutenção

  5. Push para o seu fork:

    git push origin feature/minha-funcionalidade

  6. Abra um Pull Request descrevendo suas alterações

Diretrizes de Segurança

  • Nunca faça commit de API keys, tokens ou credenciais
  • Valide e sanitize todas as entradas de usuário
  • Mantenha as dependências atualizadas
  • Documente quaisquer considerações de segurança

Diretrizes de Código

Estrutura

  • Mantenha funções focadas em uma única responsabilidade
  • Use nomes descritivos para variáveis e funções
  • Adicione comentários para lógica complexa
  • Organize imports alfabeticamente

Performance

  • Minimize operações bloqueantes
  • Use async/await apropriadamente
  • Considere o impacto de memória em ambientes com GPU limitada

Compatibilidade

  • Garanta compatibilidade com Google Colab
  • Teste em GPU T4 (16GB VRAM)
  • Considere diferentes versões do Ollama

Processo de Revisão

Todos os PRs serão revisados quanto a:

  • Qualidade do código
  • Segurança
  • Performance
  • Documentação
  • Compatibilidade

Código de Conduta

  • Seja respeitoso e profissional
  • Aceite feedback construtivo
  • Foque no que é melhor para a comunidade
  • Seja paciente com novos contribuidores

Dúvidas?

Se tiver dúvidas, abra uma issue com a tag question ou entre em contato através do repositório.

Obrigado por contribuir!