Contribuindo para este projeto
Contribuições para este projeto são sempre bem-vindas. Como colaborador, seguem as diretrizes que gostaríamos que você seguisse:
- Código de Conduta
- Solicitação de Funcionalidades
- Relato de Problemas
- Envio de Pull Requests
- Regras de Codificação
- Diretrizes de Commit
Código de Conduta
Ajude a manter este projeto aberto e inclusivo. Por favor, leia e siga o Código de Conduta.
Solicitação de Funcionalidades
Você pode solicitar uma nova funcionalidade abrindo uma issue no repositório.
- Para uma Funcionalidade Grande, abra uma issue primeiro para que a proposta possa ser discutida.
- Funcionalidades pequenas podem ser implementadas e enviadas diretamente como Pull Request.
Relato de Problemas
Antes de abrir uma issue, pesquise se ela já não foi reportada.
- Descrição geral do problema
- Motivação ou caso de uso
- Navegador e sistema operacional
- Passos para reproduzir
- Capturas de tela, se necessário
- Issues relacionadas
Envio de Pull Requests (PR)
Antes de enviar seu PR:
- Faça um fork do repositório
- Siga as convenções de código
- Adicione testes unitários e funcionais
- Execute o linter
- Atualize o changelog
git push meu-fork minha-branch
Depois, abra um Pull Request para a branch master.
Após o merge do seu PR
Você pode excluir seu fork e sincronizar com a branch principal atualizada.
Regras de Codificação
- Todas as funcionalidades ou correções devem possuir testes
- APIs públicas devem ser documentadas
- Seguimos o padrão de estilo Python PEP8
Diretrizes de Commit
Mensagens de commit devem descrever a mudança e referenciar o ID da issue.
git commit -m "#178 Remove funções obsoletas"