mirror of
https://github.com/marcogll/hr_soul23.git
synced 2026-01-13 13:25:16 +00:00
feat: Establecer la estructura de orquestación de agentes
Define la estructura de directorios y la documentación inicial para orquestar el trabajo de los agentes de IA. - Crea los directorios `src` y `docs/agents`. - Genera archivos de bitácora individuales para cada uno de los 13 agentes definidos. - Introduce `docs/CONVENTIONS.md` para establecer las reglas de nomenclatura, estilo de código y contratos de API. - Actualiza el `README.md` principal con una sección que detalla el nuevo flujo de trabajo basado en agentes, explicando cómo deben operar y documentar su progreso. Este cambio sienta las bases para un desarrollo estructurado, trazable y coherente, de acuerdo con el rol del Agente 0 (Arquitectura y Orquestación).
This commit is contained in:
120
docs/CONVENTIONS.md
Normal file
120
docs/CONVENTIONS.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# Convenciones del Proyecto – HR Platform
|
||||
|
||||
Este documento define las **convenciones técnicas y de estilo** que deben seguir todos los agentes que contribuyan al proyecto.
|
||||
|
||||
Su objetivo es asegurar la **consistencia, legibilidad y mantenibilidad** del código y la documentación.
|
||||
|
||||
---
|
||||
|
||||
## 1. Nomenclatura (Naming Conventions)
|
||||
|
||||
### 1.1 General
|
||||
|
||||
* **Idioma:** Inglés para todo el código (variables, funciones, clases). Español para documentación y comentarios si es necesario aclarar un término de negocio específico de la región.
|
||||
* **Claridad sobre brevedad:** `calculateAnnualLeave` es mejor que `calcLev`.
|
||||
|
||||
### 1.2 Variables y Funciones
|
||||
|
||||
* **Estilo:** `camelCase`.
|
||||
* Ejemplo: `const currentUser = ...;`
|
||||
* Ejemplo: `function calculateSalary(...)`
|
||||
|
||||
### 1.3 Clases y Tipos
|
||||
|
||||
* **Estilo:** `PascalCase` (o `UpperCamelCase`).
|
||||
* Ejemplo: `class EmployeeService { ... }`
|
||||
* Ejemplo: `interface UserProfile { ... }`
|
||||
|
||||
### 1.4 Constantes
|
||||
|
||||
* **Estilo:** `UPPER_CASE` con guiones bajos.
|
||||
* Ejemplo: `const MAX_LOGIN_ATTEMPTS = 5;`
|
||||
|
||||
### 1.5 Archivos
|
||||
|
||||
* **Componentes/Módulos:** `PascalCase.js` (ej. `EmployeeCard.js`)
|
||||
* **Servicios/Rutas/Config:** `kebab-case.js` (ej. `user-routes.js`, `database-config.js`)
|
||||
|
||||
---
|
||||
|
||||
## 2. Estilo de Código (Code Style)
|
||||
|
||||
### 2.1 JavaScript/Node.js
|
||||
|
||||
* **Formateador:** Prettier con la configuración por defecto.
|
||||
* **Linter:** ESLint con un conjunto de reglas estándar (ej. `eslint:recommended`).
|
||||
* **Módulos:** Usar `import`/`export` (ES Modules) en lugar de `require`/`module.exports` (CommonJS) siempre que sea posible.
|
||||
* **Punto y coma:** Obligatorio.
|
||||
|
||||
### 2.2 Comentarios
|
||||
|
||||
* **Cuándo:** Comentar lógica de negocio compleja, no código obvio.
|
||||
* **Cómo:** Usar JSDoc para funciones y módulos para describir propósito, parámetros y valores de retorno.
|
||||
|
||||
---
|
||||
|
||||
## 3. Contratos de API (API Contracts)
|
||||
|
||||
### 3.1 Endpoints
|
||||
|
||||
* **Formato:** RESTful. Usar sustantivos en plural para las colecciones.
|
||||
* `GET /api/v1/employees` (Obtener todos los empleados)
|
||||
* `GET /api/v1/employees/{id}` (Obtener un empleado)
|
||||
* `POST /api/v1/employees` (Crear un empleado)
|
||||
* `PUT /api/v1/employees/{id}` (Actualizar un empleado)
|
||||
* `DELETE /api/v1/employees/{id}` (Eliminar un empleado)
|
||||
|
||||
### 3.2 Versionado
|
||||
|
||||
* Incluir el número de versión en la URL: `/api/v1/...`
|
||||
|
||||
### 3.3 Payloads (Request/Response)
|
||||
|
||||
* **Formato:** JSON.
|
||||
* **Estilo de claves:** `camelCase`.
|
||||
* **Respuestas de error:** Usar una estructura consistente.
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"code": "VALIDATION_ERROR",
|
||||
"message": "El campo 'email' es inválido.",
|
||||
"details": [
|
||||
{ "field": "email", "issue": "Formato incorrecto" }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Commits en Git
|
||||
|
||||
### 4.1 Mensajes de Commit
|
||||
|
||||
* **Formato:** Conventional Commits.
|
||||
* `feat: Implementar login de usuarios`
|
||||
* `fix: Corregir cálculo de vacaciones en años bisiestos`
|
||||
* `docs: Actualizar README con instrucciones de despliegue`
|
||||
* `style: Formatear código con Prettier`
|
||||
* `refactor: Mover lógica de negocio a capa de servicio`
|
||||
* `test: Añadir pruebas unitarias para el módulo de permisos`
|
||||
* `chore: Actualizar dependencias de npm`
|
||||
|
||||
### 4.2 Ramas
|
||||
|
||||
* `main`: Rama principal, representa el estado de producción.
|
||||
* `develop`: Rama de integración para el trabajo en curso.
|
||||
* `test`: Rama de pruebas.
|
||||
* **Ramas de feature:** `feature/nombre-corto-del-feature` (ej. `feature/user-auth`)
|
||||
* **Ramas de bugfix:** `fix/descripcion-corta-del-bug` (ej. `fix/login-error`)
|
||||
|
||||
---
|
||||
|
||||
## 5. Documentación
|
||||
|
||||
* **Bitácoras de Agente:** Cada agente debe registrar sus decisiones y progreso en su archivo correspondiente en `docs/agents/`.
|
||||
* **READMEs:** Cualquier nuevo módulo complejo debe tener su propio `README.md` explicando su propósito y uso.
|
||||
|
||||
---
|
||||
|
||||
Este documento es una guía viva y puede ser actualizado por el **Agente 0 (Arquitectura)** según las necesidades del proyecto.
|
||||
18
docs/agents/agent-00-architecture.md
Normal file
18
docs/agents/agent-00-architecture.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 0 – Arquitectura & Orquestación
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 0**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las directrices arquitectónicas que gobiernan el proyecto.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Decisión/Observación
|
||||
|
||||
* **Contexto:** [Descripción del problema o situación]
|
||||
* **Decisión/Acción:** [Qué se decidió o qué acción se tomó]
|
||||
* **Justificación:** [Por qué se tomó esa decisión]
|
||||
* **Impacto:** [Sistemas o agentes afectados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-01-infraestructura.md
Normal file
18
docs/agents/agent-01-infraestructura.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 1 – Infraestructura & DevOps
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 1**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-02-backend.md
Normal file
18
docs/agents/agent-02-backend.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 2 – Backend Core (Node.js)
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 2**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-03-base.md
Normal file
18
docs/agents/agent-03-base.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 3 – Base de Datos & Modelado
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 3**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-04-importación.md
Normal file
18
docs/agents/agent-04-importación.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 4 – Importación Google Sheets
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 4**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-05-gestión.md
Normal file
18
docs/agents/agent-05-gestión.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 5 – Gestión de Socias
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 5**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-06-vacaciones.md
Normal file
18
docs/agents/agent-06-vacaciones.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 6 – Vacaciones (Reglas de Negocio)
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 6**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-07-permisos.md
Normal file
18
docs/agents/agent-07-permisos.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 7 – Permisos
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 7**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-08-webhooks.md
Normal file
18
docs/agents/agent-08-webhooks.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 8 – Webhooks & Eventos
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 8**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-09-seguridad.md
Normal file
18
docs/agents/agent-09-seguridad.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 9 – Seguridad & Autorización
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 9**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-10-frontend.md
Normal file
18
docs/agents/agent-10-frontend.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 10 – Frontend (Staging)
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 10**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-11-testing.md
Normal file
18
docs/agents/agent-11-testing.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 11 – Testing & QA
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 11**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
18
docs/agents/agent-12-observabilidad.md
Normal file
18
docs/agents/agent-12-observabilidad.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bitácora del Agente 12 – Observabilidad & Calidad
|
||||
|
||||
Este documento registra las decisiones, cambios y observaciones del **Agente 12**.
|
||||
|
||||
Su propósito es mantener un historial claro y auditable de las tareas y soluciones implementadas.
|
||||
|
||||
---
|
||||
|
||||
## Entradas de Bitácora
|
||||
|
||||
### [Fecha] - Tarea/Decisión
|
||||
|
||||
* **Contexto:** [Descripción del requerimiento o problema]
|
||||
* **Acción/Implementación:** [Qué se hizo o cómo se implementó]
|
||||
* **Resultado:** [Cuál fue el resultado, ej. endpoint creado, test pasado]
|
||||
* **Observaciones:** [Notas adicionales, dependencias, problemas encontrados]
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user