Contribuire

I contributi sono ben accetti e sono molto apprezzati! Ogni piccolo aiuto e il credito verrà sempre dato»

Puoi contribuire in molti modi:

Tipi di contributi

Segnala bug

Segnala bug a https://github.com/SekouD/mlconjug/issues.

Se stai segnalando un bug, includi:

  • Nome e versione del tuo sistema operativo.
  • Qualsiasi dettaglio sulla configurazione locale che potrebbe essere utile nella risoluzione dei problemi.
  • Passaggi dettagliati per riprodurre il bug.

Bug corretti

Cerca tra i problemi di GitHub per i bug. Qualsiasi cosa taggata con » bug «e » help wanted «è aperta a chiunque voglia implementarla.

Implementa funzionalità

Cerca tra i problemi di GitHub per le funzionalità. Qualsiasi cosa taggata con » enhancement «e » help wanted «è aperta a chiunque voglia implementarla.

Scrivi documentazione

MLConjug potrebbe sempre usare più documentazione, sia come parte dei documenti ufficiali di MLConjug, in docstrings, o anche sul Web in post di blog, articoli e simili.

Invia feedback

Il modo migliore per inviare feedback è presentare un problema su https://github.com/SekouD/mlconjug/issues.

Se stai proponendo una funzione:

  • Spiega in dettaglio come funzionerebbe.
  • Tieni l’ambito il più stretto possibile, per renderlo più facile da implementare.
  • Ricorda che questo è un progetto guidato dai volontari e che i contributi sono i benvenuti :)

Iniziare!

Pronto a contribuire? Ecco come impostare` mlconjug` per lo sviluppo locale.

  1. Prepara il repo “mlconjug` su GitHub.

  2. Clona la tua forcella localmente

    $ git clone git@github.com:your_name_here/mlconjug.git
    
  3. Installa la tua copia locale in un virtualenv. Supponendo che hai virtualenvwrapper installato, questo è il modo in cui imposti la tua forcella per lo sviluppo locale

    $ mkvirtualenv mlconjug
    $ cd mlconjug/
    $ python setup.py develop
    
  4. Crea un ramo per lo sviluppo locale

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

    Ora puoi apportare le modifiche localmente.

  5. Quando hai finito di fare modifiche, controlla che le tue modifiche superino flake8 e i test, incluso testare altre versioni di Python con tox

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

    Per ottenere flake8 e tox, basta installarli nel tuo virtualenv.

  6. Confida le tue modifiche e invia il tuo ramo a GitHub

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  7. Invia una richiesta di pull tramite il sito Web GitHub.

Pull Request Guidelines

Prima di inviare una richiesta di pull, controlla che soddisfi le seguenti linee guida:

  1. La richiesta di pull dovrebbe includere test.
  2. Se la richiesta pull aggiunge funzionalità, i documenti dovrebbero essere aggiornati. Inserisci la tua nuova funzionalità in una funzione con una docstring e aggiungi la funzione all’elenco in 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.

Suggerimenti

Per eseguire un sottoinsieme di test

$ py.test tests.test_mlconjug