Nos encantan los pull requests de todos. Al contribuir a este repositorio, usted acepta cumplir con el Código de Conducta.
-
Primero haga un fork del repositorio y luego clónelo usando:
git clone git@github.com:your-username/algorithms.git
-
Después de eso, crea una git branch para tus cambios. Por ejemplo:
- add_XXX Si agregara nuevos algoritmos o estructuras de datos.
- fix_XXX Si arreglará un error en un determinado algoritmo o estructura de datos.
- test_XXX Si escribiste una o más pruebas.
- doc_XXX Si ha editado o añadido a la documentación.
Usted puede contribuir:
- Implementando nuevos algoritmos en el repositorio. Asegúrese de ponerlo en la sección correcta (ej. array, dp, etc). Cree una nueva sección para él si no cae en ninguna. Asegúrese de que su implementación funciona.
- Optimizando o mejorando los algoritmos existentes.
- Añadiendo una solución diferente para el problema.
- Encontrando y corrigiendo errores.
- Añadiendo ejemplos para explicar mejor los algoritmos.
- Añadiendo casos de prueba.
- Mejorando la documentación.
Haga push a su fork y envie un pull request.
Revisaremos y sugeriremos algunos cambios, mejoras o alternativas. Algunas cosas que aumentarán la posibilidad de que su pull request sea aceptado:
- Todos los algoritmos deben estar escritos en Python 3. (Hay algunos algoritmos todavía con la sintaxis de Python 2. Puede comenzar con la conversión de aquellos a Python 3.)
- Escribir código limpio y comprensible.
- Comente correctamente el código y explique brevemente qué está haciendo el algoritmo en los docstrings.
- También puede explicar la salida usando un ejemplo mínimo.
- Trate de incluir también un par de casos de prueba para el algoritmo.
- Escriba un buen mensaje en el commit.
Envíe un nuevo issue 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 para evitar crear duplicados. También, considere resolver problemas actuales o contribuir a la discusión sobre un tema.
Puedes pedir ayuda o aclaraciones a los colaboradores. Keon Kim