Como contribuir

Seja bem-vindo! Estamos felizes em receber contribuições para este projeto. Antes de começar, aqui estão algumas orientações úteis sobre como contribuir.

Clonando o repositório

Certifique-se de clonar o repositório para o seu ambiente local antes de fazer alterações.

git clone https://github.com/Dowingows/phylogenetic_indices

Como instalar dependências

poetry install

Verificação de código

Antes de enviar uma solicitação de pull, é importante garantir que o código esteja formatado corretamente e siga as diretrizes do projeto.

task lint

Isso executará verificações automáticas para garantir que o código esteja em conformidade com as diretrizes de estilo e formatação.

Executando os testes

Certifique-se de que os testes passem antes de enviar uma solicitação de pull. Isso ajuda a garantir que as alterações não quebrem funcionalidades existentes.

task lint

Documentação

Se você estiver fazendo alterações que afetam a documentação, certifique-se de atualizá-la.

task docs

Isso garantirá que a documentação esteja em sincronia com o código atualizado.

Lembre-se de que aceitamos e incentivamos contribuições de todos. Se você encontrar algo que gostaria de melhorar ou adicionar, fique à vontade para enviar uma solicitação de pull. Se tiver dúvidas ou precisar de ajuda, não hesite em abrir uma issue. Obrigado por contribuir! 🚀

Tarefas para contribuição

Aqui estão algumas tarefas que você pode considerar ao contribuir para o projeto:

  • Implementar Average Taxonomic Distinctness (AvTD) (índice que calcula o comprimento médio do caminho conectando espécies em uma comunidade)
  • Implementar Total Taxonomic Distinctness (TTD) (índice que calcula as distinções filogenéticas médias somadas de todas as espécies)
  • Implementar The Pure Diversity (Dd) (índice que calcula a distância filogenética de uma determinada espécie até seu vizinho mais próximo)
  • Implementar The Phylogenetic Diversity (PD_node) (índice que calcula o comprimento total mínimo de todos os ramos filogenéticos necessários para medir um táxon em uma árvore filogenética)
  • Implementar (PD_root) (índice calcula o número de nós dentro do caminho de abrangência enraizado (máximo))
  • Implementar Average Phylogenetic Diversity proposto por [Vane-Wright et al. 1991] (calcular a soma das contribuições de cada espécie para a diversidade e a soma dos pesos táxis padronizados, respectivamente)

Nota: Para tarefas não listadas nesta documentação, você pode consultas as issues do projeto