Contribuyendo¶
¡Las contribuciones son bienvenidas, y son muy apreciadas! Todo ayuda, y el crédito siempre se dará.
Puedes contribuir de muchas maneras:
Tipos de contribuciones¶
Reportar errores¶
Informar errores en https://github.com/SekouD/potranslator/issues.
Si informa un error, incluya lo siguiente:
- El nombre y la versión de su sistema operativo.
- Cualquier detalle sobre su configuración local que pueda ser útil para solucionar problemas.
- Pasos detallados para reproducir el error.
Corregir errores¶
Consulte los problemas de GitHub para encontrar errores. Cualquier cosa etiquetada con «error» y «ayuda querida» está abierta para quien quiera implementarla.
Implementar funciones¶
Consulte los problemas de GitHub para conocer las características. Cualquier cosa etiquetada con «mejora» y «ayuda deseada» está abierta para quien quiera implementarla.
Escribir documentación¶
potraslador siempre podría usar más documentación, ya sea como parte de los documentos oficiales de potracionador, en documentos, o incluso en la web en publicaciones de blogs, artículos y demás.
Enviar comentarios¶
La mejor forma de enviar comentarios es presentar un problema en https://github.com/SekouD/potranslator/issues.
Si está proponiendo una función:
- Explica en detalle cómo funcionaría.
- Mantenga el alcance lo más estrecho posible, para que sea más fácil de implementar.
- Recuerde que este es un proyecto impulsado por voluntarios, y que las contribuciones son bienvenidas :)
¡Empezar!¶
Listo para contribuir? A continuación se explica cómo configurar el potrasador para el desarrollo local.
Tenedor el repositorio potraslator en GitHub.
Clona tu tenedor localmente
$ git clone git@github.com:your_name_here/potranslator.git
Instale su copia local en un virtualenv. Suponiendo que tiene virtualenvwrapper instalado, así es como configura su tenedor para el desarrollo local
$ mkvirtualenv potranslator $ cd potranslator/ $ python setup.py develop
Crear una rama para el desarrollo local
$ git checkout -b name-of-your-bugfix-or-feature
Ahora puedes hacer tus cambios localmente.
Cuando hayas terminado de hacer cambios, comprueba que tus cambios pasen a flake8 y a las pruebas, incluida la prueba de otras versiones de Python con tox
$ flake8 potranslator tests $ python setup.py test or py.test $ tox
Para obtener Flake8 y tox, simplemente pip instálelos en su Virtualenv.
Confirme sus cambios y envíe su sucursal a GitHub
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Presente una solicitud de extracción a través del sitio web de GitHub.
Pautas de solicitud de extracción¶
Antes de enviar una solicitud de extracción, verifique que cumpla con estas pautas:
- La solicitud de extracción debe incluir pruebas.
- Si la solicitud de extracción agrega funcionalidad, los documentos deberían actualizarse. Ponga su nueva funcionalidad en una función con una docstring, y agregue la característica a la lista en README.rst.
- La solicitud de extracción debería funcionar para Python 2.7, 3.4, 3.5 y 3.6, y para PyPy. Verifique https://travis-ci.org/SekouD/potranslator/pull_requests y asegúrese de que las pruebas se aprueben para todas las versiones compatibles de Python.
Despliegue¶
Un recordatorio para los mantenedores sobre cómo implementar. Asegúrese de que se hayan confirmado todos sus cambios (incluida una entrada en HISTORY.rst). Entonces corre:
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis luego se desplegará en PyPI si pasan las pruebas.