contribuire¶
I contributi sono ben accetti e sono molto apprezzati! Ogni piccolo aiuto e il credito sarà sempre dato.
Puoi contribuire in molti modi:
Tipi di contributi¶
Segnala bug¶
Segnala bug all’indirizzo https://github.com/SekouD/potranslator/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.
Correggere i bug¶
Guarda i problemi di GitHub per i bug. Qualunque taggato con «bug» e «help wanted» è aperto a chiunque voglia implementarlo.
Implementare caratteristiche¶
Esamina i problemi di GitHub per le funzionalità. Qualsiasi cosa taggata con «miglioramento» e «richiesta di aiuto» è aperta a chiunque voglia implementarla.
Scrivi documentazione¶
il traduttrice potrebbe sempre usare più documentazione, sia come parte dei documenti ufficiali di traduttori, in docstrings, o anche sul web in post di blog, articoli e simili.
Invia feedback¶
Il modo migliore per inviare feedback è presentare un problema all’indirizzo https://github.com/SekouD/potranslator/issues.
Se stai proponendo una funzione:
- Spiega in dettaglio come funzionerebbe.
- Mantenere 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 benvenuti :)
Iniziare!¶
Pronto a contribuire? Ecco come impostare potranslator per lo sviluppo locale.
Forchetta il repo potranslator su GitHub.
Clona la tua forcella localmente
$ git clone git@github.com:your_name_here/potranslator.git
Installa la tua copia locale in un virtualenv. Supponendo di aver installato virtualenvwrapper, questo è il modo in cui imposti la tua forcella per lo sviluppo locale
$ mkvirtualenv potranslator $ cd potranslator/ $ python setup.py develop
Crea un ramo per lo sviluppo locale
$ git checkout -b name-of-your-bugfix-or-feature
Ora puoi apportare le modifiche a livello locale.
Quando hai terminato le modifiche, verifica che le tue modifiche superino flake8 e i test, incluso testare altre versioni di Python con tox
$ flake8 potranslator tests $ python setup.py test or py.test $ tox
Per ottenere flake8 e tox, basta installarli nel tuo virtualenv.
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
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:
- La richiesta di pull dovrebbe includere test.
- Se la richiesta pull aggiunge funzionalità, i documenti dovrebbero essere aggiornati. Metti la tua nuova funzionalità in una funzione con una docstring e aggiungi la funzione alla lista in README.rst.
- La richiesta pull dovrebbe funzionare per Python 2.7, 3.4, 3.5 e 3.6 e per PyPy. Controlla https://travis-ci.org/SekouD/potranslator/pull_requests e assicurati che i test superino tutte le versioni di Python supportate.
Distribuzione¶
Un promemoria per i manutentori su come distribuire. Assicurati che tutte le modifiche siano state confermate (inclusa una voce in HISTORY.rst). Quindi eseguire
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis verrà quindi distribuito su PyPI se i test supereranno.