Saltar a contenido

Documentación Principal

Bienvenido a la documentación de Ether My Best Practice.

Contenidos

Resumen

Ether My Best Practice es una plantilla de buenas prácticas orientada a proyectos de API REST donde las reglas deben poder ser consumidas por agentes de IA y reutilizadas como contexto operativo:

  • 🏗️ Arquitectura hexagonal
  • 📝 Documentación como código
  • ✅ Testing y TDD
  • 🔄 Git Flow y Conventional Commits
  • 🚀 CI/CD automatizado
  • 🤖 Integración con agentes de IA (MCP)

Enfoque

Este repositorio combina dos piezas:

  • Reglas versionadas en ../rules/00-index.md para decirle a humanos y agentes cómo trabajar.
  • Plantillas en ../templates/ para que un agente pueda generar el cascarón inicial de una API REST coherente con esas reglas.

La combinación permite que un MCP o un agente local no solo lea normas, sino que también tenga una base estructural para crear archivos y carpetas siguiendo el estándar.

Para Empezar

  1. Lee Getting Started
  2. Consulta las Reglas
  3. Usa las Plantillas