Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (33 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

41 lines (33 loc) · 2.56 KB
Raw

Guía de Contribución

¡Gracias por considerar contribuir a este ecosistema! Al ser parte de un ecosistema diseñado bajo los estándares de observabilidad, reproducibilidad, calidad local-first e idempotencia, mantenemos expectativas altas sobre la integridad del código para mantener este portafolio como un reflejo de ingeniería moderna.

Tipos de Contribuciones que Buscamos

  • 🐛 Corrección de Bugs: Resolver problemas identificados, preferiblemente sumando una prueba automatizada (pytest, etc.) que compruebe la solución.
  • 🚀 Nuevas Funcionalidades: Mejoras arquitectónicas, nuevas integraciones (e.g. con n8n, Ollama o LangGraph).
  • 📖 Documentación: Claridad, traducciones o diagramas de arquitectura explícitos (Mermaid o draw.io).
  • 🏗️ Infraestructura: Mejoras a los flujos DevOps (K8s, CI/CD, Makefiles, PWA Configurations).

Flujo de Trabajo (Git Flow)

Este proyecto usa un flujo estandarizado basado en ramas de características:

  1. Haz Fork del repositorio a tu cuenta.
  2. Crea una rama para tu funcionalidad o corrección partiendo del estado más reciente de la rama main: 
    git checkout -b feature/nueva-magia-a-aws
# o para fixes
git checkout -b fix/auth-bypass
  3. Desarrolla tu funcionalidad.
    • Asegúrate de seguir la filosofía del repositorio. Si estamos usando uv para Python de alto rendimiento, no uses otra cosa a menos que justifiques el cambio.
    • Comprueba los guardsrails existentes en el proyecto.
  4. Haz Commit a tus cambios. Usamos Conventional Commits (feat:, fix:, docs:, chore:, etc.): 
    git commit -m "feat: implementar circuit breaker global para llamadas fallidas"
  5. Haz Push a tu rama: 
    git push origin feature/nueva-magia-a-aws
  6. Abre un Pull Request (PR) hacia la rama main de este repositorio.

Estándares del Código

  • Test-Driven Development (opcional pero recomendado): Incluye comandos para correr tus pruebas. Si el repositorio tiene Action de GitHub con mypy o bandit, asegúrate de que tus modificaciones pasen localmente (make test, make lint o scripts disponibles en el ecosistema).
  • Docker-first: Cualquier dependencia requerida debe estar documentada y disponible mediante docker-compose.yml para levantar la arquitectura en menos de 60 segundos u obviar la fricción del setup local.
  • Documentación obligatoria: Si es un cambio mayor, no olvides la documentación en el README y si es aplicable, un diagrama explicativo.