|
| 1 | +# Contribuyendo |
| 2 | + |
| 3 | +Nos encantan los pull requests de todos. Al contribuir a este repositorio, usted acepta cumplir con el [Código de Conducta](CODE_OF_CONDUCT.md). |
| 4 | + |
| 5 | +## Comenzando |
| 6 | + |
| 7 | +* Primero haga un [fork][fork] del repositorio y luego clónelo usando: |
| 8 | + |
| 9 | + git clone [email protected]:your-username/algorithms.git |
| 10 | + |
| 11 | +* Después de eso, crea una git branch para tus cambios. Por ejemplo: |
| 12 | + * add_XXX Si agregara nuevos algoritmos o estructuras de datos. |
| 13 | + * fix_XXX Si arreglará un error en un determinado algoritmo o estructura de datos. |
| 14 | + * test_XXX Si escribiste una o más pruebas. |
| 15 | + * doc_XXX Si ha editado o añadido a la documentación. |
| 16 | + |
| 17 | +Usted puede contribuir: |
| 18 | +- Implementando nuevos algoritmos en el repositorio. Asegúrese de ponerlo en la sección correcta (ej. [array](array), [dp](dp), etc). Cree una nueva sección para él si no cae en ninguna. Asegúrese de que su implementación funciona. |
| 19 | +- Optimizando o mejorando los algoritmos existentes. |
| 20 | +- Añadiendo una solución diferente para el problema. |
| 21 | +- Encontrando y corrigiendo errores. |
| 22 | +- Añadiendo ejemplos para explicar mejor los algoritmos. |
| 23 | +- Añadiendo casos de prueba. |
| 24 | +- Mejorando la documentación. |
| 25 | + |
| 26 | +## Pull Requests |
| 27 | +Haga push a su fork y [envie un pull request][pr]. |
| 28 | + |
| 29 | +Revisaremos y sugeriremos algunos cambios, mejoras o alternativas. Algunas cosas que aumentarán la posibilidad de que su pull request sea aceptado: |
| 30 | + |
| 31 | + |
| 32 | +* Todos los algoritmos deben estar escritos en **Python 3**. |
| 33 | +(Hay algunos algoritmos todavía con la sintaxis de _Python 2_. Puede comenzar con la conversión de [aquellos][issue120] a _Python 3_.) |
| 34 | +* Escribir código limpio y comprensible. |
| 35 | +* Comente correctamente el código y explique brevemente qué está haciendo el algoritmo en los [docstrings][docstr]. |
| 36 | +* También puede explicar la salida usando un ejemplo mínimo. |
| 37 | +* Trate de incluir también un par de casos de prueba para el algoritmo. |
| 38 | +* Escriba un [buen mensaje en el commit][commit]. |
| 39 | + |
| 40 | + |
| 41 | +## Issues |
| 42 | +Envíe un [nuevo issue][newissue] si hay un algoritmo por agregar, o si se encontró un error en un algoritmo existente. Antes de enviar un nuevo issue, revise lo [issues existentes][issues] para evitar crear duplicados. También, considere resolver problemas actuales o contribuir a la discusión sobre un tema. |
| 43 | + |
| 44 | +## Colaboradores |
| 45 | +Puedes pedir ayuda o aclaraciones a los colaboradores. |
| 46 | +[Keon Kim](https://github.com/keon) |
| 47 | + |
| 48 | +[Rahul Goswami](https://github.com/goswami-rahul) |
| 49 | + |
| 50 | +[Ankit Agarwal](https://github.com/ankit167) |
| 51 | + |
| 52 | +[Hai Hoang Dang](https://github.com/danghai) |
| 53 | + |
| 54 | +[Saad](https://github.com/SaadBenn) |
| 55 | + |
| 56 | +[fork]: https://help.github.com/articles/fork-a-repo/ |
| 57 | +[docstr]: https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings |
| 58 | +[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
| 59 | +[pr]: https://github.com/keon/algorithms/compare/ |
| 60 | +[newissue]: https://github.com/keon/algorithms/issues/new |
| 61 | +[issue120]: https://github.com/keon/algorithms/issues/120 |
| 62 | +[issues]: https://github.com/keon/algorithms/issues/ |
0 commit comments