Bienvenido a la guía de contribución de gget

¡Gracias por invertir su tiempo en contribuir con nuestro proyecto! Cualquier contribución que hagas se verá reflejada en el repositorio de GitHub de gget. ✨

Lea nuestro Código de conducta para mantener nuestra comunidad accesible y respetable.

En esta guía, obtendrá una descripción general del flujo de trabajo de contribución desde la creación de un GitHub Issue (asunto) o la creación de un GitHub Pull Request (PR) hasta la revisión y fusión de un PR.

Issues (asuntos)

Crear un nuevo Issue

Si detecta un problema con gget o tiene una idea para una nueva función, comproba si ya existe un Issue para este problema/sugerencia. Si no existe un Issue relacionado, puede abrir un nuevo Issue utilizando el formulario correspondiente.

Resolver un Issue

Explore nuestros Issues existentes para encontrar uno que le interese. Puede restringir la búsqueda utilizando "labels" como filtros. Si encuentra un Issue en el que desea trabajar, puede abrir un PR con una solución.

Contribuir a través de Pull Requests (PRs)

Empezar

1. Bifurcar ("fork") el repositorio de GitHub de gget.

• Usando GitHub Desktop:

  • "Getting started with GitHub Desktop" lo guiará a través de la configuración de Desktop.
  • Una vez que GitHub Desktop está configurado, puede usarlo para bifurcar el repositorio!

• Usando la Terminal:

  • Bifurca el repositorio para que pueda realizar sus cambios sin afectando el proyecto original hasta que esté listo para fusionarlos.

2. ¡Cree una rama de trabajo y comience con sus cambios!

Confirma sus actualizaciones

Confirme sus cambios una vez que esté satisfecho con ellos.

‼️ Auto-revisa lo siguiente antes de crear un PR ‼️

1. Revise el contenido para mantener precisión técnica.
2. Edite los cambios/comentarios de gramática, ortografía y adherencia al estilo general del código de gget existente.
3. Formatee su código usando "black".
4. Asegúrese de que las pruebas unitarias pasen:
   • Las dependencias de desarrollador se pueden instalar con pip install -r dev-requirements.txt
   • Ejecute pruebas unitarias existentes desde la carpeta de gget con coverage run -m pytest -ra -v tests && coverage report --omit=main.py,tests*
5. Agregue nuevas pruebas unitarias si corresponde:
   • Los parámetros y los resultados esperados se pueden encontrar en archivos json en ./tests/fixtures/
   • Las pruebas unitarias se pueden agregar a ./tests/test_*.py y serán detectado automáticamente
6. Asegúrese de que las ediciones sean compatibles tanto con Python como con la Terminal
   • Los parámetros para la Terminal se definen en ./gget/main.py
7. Agregue módulos/argumentos nuevos a la documentación, si corresponde:
   • El manual de cada módulo se puede editar/añadir como ./docs/src/*.md

Si tiene alguna pregunta, no dude en iniciar una discusión o crear un Issue como se describe anteriormente.

Crear un Pull Request (PR)

Cuando haya terminado con los cambios, cree un Pull Request, también conocido como "PR".

‼️ Realice todos los PRs contra la rama dev del repositorio gget

• No olvide de vincular su PR con un Issue si estás resolviendo uno.
• Habilite la casilla de verificación para permitir ediciones del mantenedor para que la rama se pueda actualizar para una fusión.
• Si se encuentra con problemas durante la fusión, consulte este tutorial de git para ayudarlo a resolver conflictos de fusión y otros problemas.

Una vez que envíe su PR, un miembro del equipo gget revisará su propuesta. Podemos hacer preguntas o solicitar información adicional.

¡Su PR está fusionado!

¡Felicidades! 🎉 El equipo de gget te lo agradece. ✨

Una vez que su PR se fusione, sus contribuciones serán visibles públicamente en el repositorio de gget.