Contribuer¶

Les contributions sont les bienvenues, et elles sont grandement appréciées! Chaque petit coup de pouce aide, et le crédit sera toujours donné.

Vous pouvez contribuer de plusieurs façons:

Types de contributions¶

Signaler les bugs¶

Rapportez les bugs sur https://github.com/SekouD/potranslator/issues.

Si vous signalez un bug, veuillez inclure:

Le nom et la version de votre système d’exploitation.
Tous les détails concernant votre configuration locale qui pourraient être utiles pour le dépannage.
Étapes détaillées pour reproduire le bug.

Corriger les bugs¶

Regardez sur le site GitHub du projet pour les bugs. Tout ce qui est marqué « bug » et « help wanted » est ouvert à quiconque veut l’implémenter.

Implémenter de nouvelles fonctionnalités¶

Regardez sur la page GitHub du projet pour les fonctionnalités. Tout ce qui est marqué « amélioration » et « help wanted » est ouvert à quiconque veut l’implémenter.

Écrire de la documentation¶

potranslator pourrait toujours utiliser plus de documentation, que ce soit dans le cadre de la doc officielle de potranslator, dans les docstrings, ou même sur le web dans des articles de blog, et autres.

Soumettre des commentaires¶

La meilleure façon d’envoyer vos commentaires est de déposer un problème sur https://github.com/SekouD/potranslator/issues.

Si vous proposez une fonctionnalité:

Expliquez en détail comment cela fonctionnerait.
Gardez la portée aussi étroite que possible, pour rendre la fonctionnalité plus facile à mettre en œuvre.
Rappelez-vous que c’est un projet dirigé par des bénévoles, et que les contributions sont les bienvenues :)

Commencez!¶

Prêt à contribuer? Voici comment configurer potranslator pour le développement local.

Forkez le repo potranslator sur GitHub.

Cloner votre fork localement

$ git clone git@github.com:your_name_here/potranslator.git

Installez votre copie locale dans un virtualenv. En supposant que virtualenvwrapper soit installé, voici comment configurer votre fork pour le développement local:
```
$ mkvirtualenv potranslator
$ cd potranslator/
$ python setup.py develop
```
Créer une branche pour le développement local
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Vous pouvez maintenant effectuer vos modifications localement.
Lorsque vous avez fini de faire des changements, vérifiez que vos changements passent flake8 et les tests, y compris le test d’autres versions de Python avec tox
```
$ flake8 potranslator tests
$ python setup.py test or py.test
$ tox
```
Pour obtenir flake8 et tox, il suffit de les installer dans votre virtualenv.

Validez vos changements et faites un push de votre branche vers GitHub

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Soumettez une pull request sur le site Web de GitHub.

Directives des Pull Request¶

Avant de soumettre une pull request, vérifiez qu’elle respecte les consignes suivantes:

La pull request doit inclure des tests.
Si la pull request ajoute une fonctionnalité, la documentation doit être mise à jour. Mettez votre nouvelle fonctionnalité dans une fonction avec une docstring et ajoutez la fonctionnalité à la liste dans README.rst.
La requête pull devrait fonctionner pour Python 2.7, 3.4, 3.5 et 3.6, et pour PyPy. Vérifiez https://travis-ci.org/SekouD/potranslator/pull_requests et assurez-vous que les tests réussissent pour toutes les versions Python supportées.

Conseils¶

Pour exécuter un sous-ensemble des tests

$ py.test tests.test_potranslator

Déployer¶

Un rappel pour les mainteneurs sur la façon de déployer. Assurez-vous que toutes vos modifications sont validées (y compris une entrée dans HISTORY.rst). Puis exécutez

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis déploiera ensuite le package sur PyPI si les tests réussissent.