Contribuindo

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

Você pode contribuir de várias maneiras:

Tipos de Contribuições

Reportar erros

Reportar bugs em https://github.com/SekouD/mlconjug/issues.

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

  • O nome e a versão do seu sistema operacional.
  • Quaisquer detalhes sobre sua configuração local que possam ser úteis na solução de problemas.
  • Etapas detalhadas para reproduzir o bug.

Corrigir erros

Olhe através dos problemas do GitHub para erros. Qualquer coisa marcada com » bug «e » help wanted «está aberta para quem quiser implementá-lo.

Implementar recursos

Examine os problemas do GitHub para recursos. Qualquer coisa marcada com » aprimoramento «e » ajuda desejada «está aberta a quem quiser implementá-la.

Write Documentation

O MLConjug poderia sempre usar mais documentação, seja como parte dos documentos oficiais do MLConjug, em docstrings, ou mesmo na web, em posts de blogs, artigos e outros.

Enviar feedback

A melhor maneira de enviar feedback é enviar um problema para https://github.com/SekouD/mlconjug/issues.

Se você está propondo um recurso:

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

Iniciar!

Pronto para contribuir? Veja como configurar o “mlconjug” para desenvolvimento local.

  1. Empurre o repositório` mlconjug` no GitHub.

  2. Clone seu garfo localmente

    $ git clone git@github.com:your_name_here/mlconjug.git
    
  3. Instale sua cópia local em um virtualenv. Assumindo que você tenha o virtualenvwrapper instalado, é assim que você configura seu fork para o desenvolvimento local:

    $ mkvirtualenv mlconjug
    $ cd mlconjug/
    $ python setup.py develop
    
  4. Criar uma filial para desenvolvimento local

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Agora você pode fazer suas alterações localmente.

  5. Quando você terminar de fazer alterações, verifique se suas alterações passam no flake8 e nos testes, incluindo testes de outras versões do Python com o tox

    $ flake8 mlconjug tests
    $ python setup.py test or py.test
    $ tox
    

    Para obter o flake8 e o tox, basta instalá-los em seu virtualenv»

  6. Confirme suas alterações e envie sua ramificação para o GitHub

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  7. Envie uma solicitação pull através do site do GitHub.

Diretrizes de solicitação pull

Antes de enviar uma solicitação de recebimento, verifique se ela atende a estas diretrizes:

  1. O pedido pull deve incluir testes.
  2. Se a solicitação pull adiciona funcionalidade, os documentos devem ser atualizados. Coloque sua nova funcionalidade em uma função com uma docstring e adicione o recurso à lista em README.rst.
  3. The pull request should work for Python 3.3, 3.4, 3.5 and 3.6. Check https://travis-ci.org/SekouD/mlconjug/pull_requests and make sure that the tests pass for all supported Python versions.

Dicas

Para executar um subconjunto de testes

$ py.test tests.test_mlconjug