Contribuir

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 de errores en https://github.com/SekouD/mlconjug/issues»

Si informa un error, por favor incluya:

  • 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

Revise los problemas de GitHub para detectar errores. Cualquier cosa etiquetada con » error «y » ayuda deseada «está abierta para quien quiera implementarla.

Implementar características

Revise los problemas de GitHub para ver las características. Todo lo que esté etiquetado con » mejora «y » ayuda deseada «está abierto a quien quiera implementarlo.

Escribir documentación

MLConjug siempre podría usar más documentación, ya sea como parte de los documentos oficiales de MLConjug, en docstrings, o incluso en la web en publicaciones de blogs, artículos, etc.

Enviar comentarios

La mejor forma de enviar comentarios es presentar un problema en https://github.com/SekouD/mlconjug/issues»

Si estás 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»
  • Recuerda que este es un proyecto impulsado por voluntarios, y que las contribuciones son bienvenidas :)

¡Empezar!

¿Listo para contribuir? Así es cómo configurar` mlconjug` para el desarrollo local «

  1. Tenedor el repositorio` mlconjug` en GitHub.

  2. Clona tu tenedor localmente:

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

  3. Instale su copia local en un virtualenv. Suponiendo que tiene virtualenvwrapper instalado, así es como configura su tenedor para el desarrollo local

    $ mkvirtualenv mlconjug
$ cd mlconjug/
$ python setup.py develop

  4. Crear una sucursal para el desarrollo local

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

    Ahora puedes hacer tus cambios localmente»

  5. Cuando hayas terminado de hacer cambios, verifica que tus cambios pasen a flake8 y las pruebas, incluida la prueba de otras versiones de Python con tox

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

    Para obtener flake8 y tox, solo pip instálalos en tu virtualenv»

  6. 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

  7. Presentar 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:

  1. La solicitud de extracción debe incluir pruebas»
  2. Si la solicitud de extracción agrega funcionalidad, los documentos deben actualizarse. Ponga su nueva funcionalidad en una función con un docstring, y agregue la función a la lista en README.rst.
  3. La solicitud de extracción debería funcionar para Python 3.3, 3.4, 3.5 y 3.6. Consulte https://travis-ci.org/SekouD/mlconjug/pull_requests y asegúrese de que las pruebas se aprueben para todas las versiones compatibles de Python.

Consejos

Para ejecutar un subconjunto de pruebas

$ py.test tests.test_mlconjug