Documentación de GitHub

Este directorio contiene toda la documentación y configuración relacionada con el flujo de trabajo, convenciones y procesos del proyecto.

---

Documentos Disponibles

Para Modelos de Asistencia de Código

• CONTEXT.md LEER PRIMERO
  • Contexto completo del proyecto
  • Estructura y convenciones
  • Estado actual y objetivos
  • Este es el documento principal que deben leer los asistentes de IA

Flujo de Trabajo

• WORKFLOW.md

  • Flujo completo de desarrollo
  • Proceso paso a paso
  • Ejemplos prácticos

• BRANCH_STRATEGY.md

  • Estrategia de ramas
  • Nomenclatura y propósito
  • Flujo de trabajo con ramas

• COMMIT_CONVENTION.md

  • Convención de commits en español
  • Tipos y formatos
  • Ejemplos y buenas prácticas

Templates

• PULL_REQUEST_TEMPLATE.md

  • Template para Pull Requests
  • Checklist y estructura

• ISSUE_TEMPLATE/

  • bug_report.md - Template para reportes de bugs
  • feature_request.md - Template para solicitudes de features
  • refactor_request.md - Template para solicitudes de refactorización

---

Inicio Rápido para Asistentes de IA

Si eres un modelo de asistencia de código, empieza aquí:

1. Lee CONTEXT.md para entender el proyecto
2. Revisa WORKFLOW.md para entender el flujo de trabajo
3. Consulta COMMIT_CONVENTION.md antes de hacer commits
4. Revisa BRANCH_STRATEGY.md antes de crear ramas

---

Checklist para Asistentes de IA

Antes de hacer cualquier cambio, asegúrate de:

• Leer CONTEXT.md completamente
• Entender el estado actual del proyecto
• Verificar las convenciones de código
• Revisar la estrategia de ramas
• Usar commits convencionales en español
• Crear rama apropiada para cambios relevantes
• Actualizar documentación si es necesario

---

Enlaces Útiles

Documentación del Proyecto

• docs/00-PLAN-MAESTRO.md - Plan maestro del proyecto
• docs/STATUS.md - Estado actual del proyecto
• docs/CHANGELOG.md - Historial de cambios

Configuración

• .github/ - Este directorio
• docs/ - Documentación del proyecto
• guidelines/ - Guías adicionales

---

Notas

• Todos los commits deben seguir la convención en español
• Siempre crear rama para cambios relevantes
• Actualizar docs/STATUS.md al completar tareas importantes
• Mantener consistencia con el código existente

---

Última actualización: 2025-01-27