Guia do Colaborador¶
Obrigado pelo seu interesse em melhorar este projeto. Este projeto é de código aberto sob a licença GPLv3+ e aceita contribuições na forma de relatórios de bugs, solicitações de recursos e pull requests.
Aqui está uma lista de recursos importantes para contribuidores:
Como relatar um bug¶
Relate bugs no Rastreador de problemas.
Ao registrar um problema, certifique-se de responder a estas perguntas:
- Qual sistema operacional e versão do Python você está usando?
- Qual versão deste projeto você está usando?
- O que você fez?
- O que você esperava ver?
- O que você viu em vez disso?
A melhor maneira de corrigir seu bug é fornecer um caso de teste e/ou etapas para reproduzir o problema.
Como configurar seu ambiente de desenvolvimento¶
Você precisa do Python 3.8+ e do Hatch.
Instale o pacote com requisitos de desenvolvimento:
hatch run dev:init
Como testar o projeto¶
Execute o conjunto de testes:
hatch test
Execute os testes para apenas uma versão do Python:
hatch test -py=3.12
Liste os comandos disponíveis:
hatch env show
Os testes de unidade estão localizados no diretório de tests/ e são escritos usando a estrutura de testes ward.
Como enviar alterações¶
Abra um pull request para enviar alterações a este projeto.
Sua solicitação pull precisa atender às seguintes diretrizes para aceitação:
- O conjunto de testes deve passar sem erros e avisos.
- Incluir testes unitários. Este projeto mantém a cobertura do código.
- Se suas alterações adicionar ou alterar funcionalidades, atualize a documentação adequadamente.
Sinta-se à vontade para enviar com antecedência - sempre podemos discutir sobre.