Contribuir#

Contribuições são bem-vindas e muito apreciadas! Toda ajuda é importante, e o crédito será sempre dado ao autor.

Tipos de contribuições#

Relatar erros#

Se você estiver relatando um bug, inclua:

  • Nome e versão do seu sistema operacional.

  • Quaisquer detalhes sobre sua configuração local que possam ser úteis na solução de problemas.

  • Passos detalhados para reproduzir o bug.

Corrigir erros#

Dê uma olhada nas issues do GitHub para verificar se há bugs. Qualquer item marcado com as tags “bug” e “help wanted” está aberto para quem quiser implementá-lo.

Implementar recursos#

Dê uma olhada nas issues do GitHub relacionadas a funcionalidades. Qualquer item marcado com as tags “enhancement” e “help wanted” está aberto para quem quiser implementá-lo.

Redigir documentação#

Documentação nunca é demais! Fique à vontade para contribuir com qualquer parte da documentação, seja nos documentos oficiais, nas descrições de função (docstrings) ou mesmo na web, por meio de posts em blogs, artigos e similares.

Enviar comentários#

Se você estiver propondo um recurso:

  • Explique em detalhes como isso funcionaria.

  • Mantenha o escopo o mais restrito possível, para facilitar a implementação.

  • Lembre-se de que este é um projeto conduzido por voluntários e que as contribuições são bem-vindas :)

Comece agora!#

Pronto para contribuir? Veja aqui como configurar o ambiente deamazonasdatahub desenvolvimento local.

  1. Baixe uma cópia do arquivo localmenteamazonasdatahub.

  2. Crie e ative um ambiente conda paraamazonasdatahub:

    $ conda create -n amazonasdatahub python=3.12
    $ conda activate amazonasdatahub
    
  3. Instale usandoamazonasdatahub``poetry:

    $ poetry install
    
  4. Use (gitou algo semelhante) para criar um branch para desenvolvimento local e fazer suas alterações:

    $ git checkout -b name-of-your-bugfix-or-feature
    
  5. Quando terminar de fazer as alterações, verifique se elas estão em conformidade com os requisitos de formatação do código e se passam em todos os testes.

  6. Faça o commit das suas alterações e abra uma solicitação de pull.

Diretrizes para pull requests#

Antes de enviar uma solicitação de pull, verifique se ela está de acordo com estas diretrizes:

  1. A solicitação de pull deve incluir testes adicionais, se for o caso.

  2. Se a solicitação de pull adicionar funcionalidades, a documentação deve ser atualizada.

  3. A solicitação de pull deve funcionar em todos os sistemas operacionais e versões do Python atualmente compatíveis.

Código de Conduta#

Observe que o projetoamazonasdatahub é lançado com um Código de Conduta. Ao contribuir para este projeto, você concorda em respeitar seus termos.