Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (81 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

128 lines (81 loc) · 3.05 KB

🤝 Guía de Contribución

¡Gracias por tu interés en contribuir a este repositorio! Este proyecto busca crear contenido de calidad sobre Ingeniería de Datos en español para ayudar a la comunidad.

📋 ¿Cómo puedo contribuir?

🐛 Reportar errores

Si encuentras un error, typo o contenido que puede mejorarse:

  1. Abre un Issue con:
    • Descripción clara del problema
    • Ubicación del archivo (ruta)
    • Sugerencia de corrección (si la tienes)

✍️ Mejorar contenido existente

  1. Fork el repositorio
  2. Crea una rama para tu cambio: git checkout -b mejora/nombre-del-cambio
  3. Realiza tus cambios
  4. Commit con mensajes claros
  5. Push a tu fork
  6. Abre un Pull Request

📝 Agregar nuevo contenido

Si quieres agregar un nuevo tema o completar contenido pendiente:

  1. Revisa el README.md para ver qué está pendiente
  2. Abre un Issue primero para discutir el tema (opcional pero recomendado)
  3. Sigue el proceso de Pull Request descrito arriba

📐 Estándares de contenido

Estructura de documentos

Los archivos .md deben seguir esta estructura:

# Título del Documento

Breve introducción (1-2 párrafos).

---

## Sección Principal

Contenido...

### Subsección

Más contenido...

---

## Otra Sección

...

Estilo de escritura

  • Claridad sobre complejidad: Explica conceptos de forma simple
  • Ejemplos prácticos: Incluye código y casos de uso reales
  • En español: Todo el contenido debe estar en español
  • Formato consistente: Usa emojis moderadamente, títulos claros

Código

  • Incluye comentarios en español
  • Ejemplos ejecutables cuando sea posible
  • Explica qué hace cada parte importante
  • Usa nombres de variables descriptivos

🔍 Proceso de revisión

  1. Tu PR será revisado por el mantenedor
  2. Puede haber sugerencias de mejora
  3. Una vez aprobado, se mergeará al repositorio
  4. ¡Tu contribución aparecerá en el repositorio!

✅ Checklist antes de hacer PR

  • El contenido está en español
  • Sigue la estructura de documentos establecida
  • Los ejemplos de código funcionan (si aplica)
  • No hay typos ni errores gramaticales
  • El contenido es claro y útil
  • He actualizado el README si agregué nuevo contenido

🎯 Áreas donde más necesitamos ayuda

  • Completar archivos que solo tienen títulos
  • Agregar ejemplos prácticos de código
  • Mejorar explicaciones técnicas
  • Agregar diagramas o visualizaciones
  • Crear proyectos end-to-end completos
  • Traducir o adaptar contenido de calidad

📞 ¿Dudas?

Si tienes dudas sobre cómo contribuir:

  • Abre un Issue con la etiqueta question
  • Revisa los Issues existentes
  • Contacta al mantenedor por LinkedIn

🙏 Agradecimientos

¡Gracias por ayudar a hacer este repositorio mejor para toda la comunidad de habla hispana!

Nota: Al contribuir, aceptas que tu contenido será publicado bajo la LICENSE del repositorio (MIT).