Saltar a contenido

🛠️ Guía de Contribución

¡Agradecemos tu interés en contribuir al P2P Dashboard! Este proyecto de código abierto se beneficia enormemente de la comunidad. Ya sea que quieras reportar un error, sugerir una nueva característica, mejorar la documentación o enviar código, tu ayuda es bienvenida. Esta guía te proporcionará los pasos y las mejores prácticas para contribuir de manera efectiva.

Cómo Contribuir

1. Reportar Errores

Si encuentras un error, por favor, repórtalo en la sección de Issues del repositorio de GitHub. Antes de crear un nuevo issue, busca si ya existe uno similar. Al reportar un error, incluye:

  • Una descripción clara y concisa del problema.
  • Pasos para reproducir el error.
  • El comportamiento esperado y el comportamiento actual.
  • Cualquier mensaje de error o traza de pila (stack trace) relevante.
  • Tu entorno (sistema operativo, versión de Python, etc.).

2. Sugerir Nuevas Características

Las nuevas ideas son siempre bienvenidas. Si tienes una sugerencia para una nueva característica o mejora, abre un issue en GitHub. Describe la característica, por qué crees que sería útil y cómo podría implementarse (si tienes alguna idea).

3. Mejorar la Documentación

La documentación es una parte vital de cualquier proyecto. Si encuentras errores tipográficos, secciones poco claras o áreas que necesitan más detalle, puedes:

  • Abrir un issue describiendo la mejora.
  • Directamente enviar un Pull Request con los cambios propuestos (ver sección de Envío de Pull Requests).

4. Enviar Código (Pull Requests)

Si deseas contribuir con código, sigue estos pasos:

a. Configura tu Entorno de Desarrollo

Si aún no lo has hecho, sigue la guía de Entorno de Desarrollo para configurar tu máquina.

b. Crea una Rama (Branch)

Trabaja siempre en una rama separada para tus cambios. Utiliza un nombre descriptivo para tu rama (ej. feature/nueva-funcionalidad o fix/nombre-del-bug).

git checkout -b feature/nombre-de-tu-funcionalidad

c. Realiza tus Cambios

Implementa tus cambios. Asegúrate de:

  • Seguir las convenciones de estilo de código existentes (PEP 8 para Python).
  • Escribir pruebas unitarias y/o de integración para tus cambios. Si estás corrigiendo un error, añade una prueba que demuestre que el error ha sido corregido.
  • Asegurarte de que todas las pruebas existentes pasen.
  • Actualizar la documentación si tus cambios afectan la funcionalidad o la API.

d. Ejecuta las Pruebas y el Linter

Antes de enviar tu Pull Request, asegúrate de que todo funciona correctamente y cumple con los estándares de calidad:

pytest # Ejecuta todas las pruebas
ruff check . # Ejecuta el linter (asegúrate de tener ruff instalado)

e. Realiza Commits Significativos

Divide tus cambios en commits lógicos y atómicos. Escribe mensajes de commit claros y concisos que describan el qué y el porqué de cada cambio.

git add .
git commit -m "feat: Añadir nueva funcionalidad X"

f. Envía tu Rama (Push)

Sube tu rama a tu fork de GitHub:

git push origin feature/nombre-de-tu-funcionalidad

g. Abre un Pull Request (PR)

Ve a la página del repositorio en GitHub y verás una opción para abrir un Pull Request desde tu rama. Al crear el PR, asegúrate de:

  • Proporcionar un título claro y conciso.
  • Escribir una descripción detallada de los cambios, incluyendo el problema que resuelve o la característica que añade.
  • Referenciar cualquier issue relacionado (ej. Closes #123).
  • Incluir capturas de pantalla o GIFs si tus cambios son visuales.

5. Proceso de Revisión del Código

Una vez que envíes tu Pull Request, un mantenedor del proyecto lo revisará. Es posible que te pidan realizar cambios o aclaraciones. Sé paciente y receptivo a los comentarios. Una vez que el PR sea aprobado, se fusionará con la rama principal.

¡Gracias por tu contribución y por ayudar a mejorar el P2P Dashboard!