Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

91 lines (57 loc) · 3.25 KB
Raw

Contribuindo

Contribuições são bem-vindas e muito apreciadas!

Você pode contribuir de várias maneiras:

Tipos de Contribuições

Reportando erros

Informe erros em https://github.com/mstuttgart/pysigep/issues.

Se você está reportando um bug, por favor inclua:

  • O nome e a versão do seu sistema operacional.
  • Qualquer detalhe sobre sua configuração local que possa ser útil na solução de problemas.
  • Etapas detalhadas para reproduzir o bug.

Corrigindo erros

Busque na lista de issues por aquelas com a tag Bug. Qualquer issue marcada com "Bug" está aberta para quem quiser corrigi-la.

Adicionando novos recursos

Busque na lista de issues por aquelas com a tag Improvement ou New feature. Qualquer issue marcada com esses tags está aberta para quem quiser implementá-la.

Melhorando a documentação

A documentação da PySIGEP sempre pode ser melhorada, seja como parte do da documentação oficial do PySIGEP, em docstrings, ou mesmo na web em postagens de blog, artigos e etc. Então caso você tenha escrito alguma postagem sobre a PySIGEP, por favor, me avise para que a mesma seja incluída aqui como referência.

Enviar Comentários

A melhor maneira de enviar comentários é abrir uma issue em https://github.com/mstuttgart/pysigep/issues.

Se você está propondo um novo recurso para PySIGEP, por favor siga os seguintes passos:

  • Explique em detalhes como isso funcionaria.
  • Mantenha o escopo o mais simples possível, para facilitar a implementação.
  • Lembre-se que este é um projeto voluntário, e que contribuições são bem-vindos :)

Começando a contribuir!

Pronto para contribuir? Veja como configurar pysigep para desenvolvimento local.

  1. Fork o repositório pysigep no GitHub.

  2. Clone sua branch localmente::

    git clone git@github.com:your_name_here/pysigep.git

  3. Instale sua cópia local em um virtualenv. Supondo que você tenha instalado o virtualenv, é assim que você configura a seu fork para o desenvolvimento local::

    cd pysigep
virtualenv -p python3 env
pip3 install -r requirements.txt

  4. Crie uma branch para desenvolvimento::

    git checkout -b nome-da-sua-branch

   Agora você pode fazer suas mudanças localmente.

  1. Quando terminar de fazer alterações, verifique se suas alterações passam no flake8 e nos testes::

    $ flake8 pysigep tests
$ python setup.py test

  2. Confirme as suas alterações e as envie para o GitHub::

    $ git add .
$ git commit -m "Descricao detalhada das sua alteracoes."
$ git push origin nome-da-sua-branch

  3. Envie um Pull Request para o repositório oficial da PySIGEP no GitHub.

Instruções de Solicitação de Pull Request

Antes de enviar um pedido de Pull Request, verifique se ele atende a essas diretrizes:

  1. O pedido de Pull Request deve incluir testes, quando for uma nova feature.
  2. Se o Pull Request adicionar funcionalidades, a documentação deve ser atualizada adicionado detalhes de uso da nova funcionalidade.
  3. O pedido de Pull Request deve funcionar para o Python 3.5+. Verificar https://travis-ci.org/mstuttgart/pysigep/pull_requests e certifique-se de que os testes passem para todas as versões do Python suportadas.