Skip to content

Comments

entrega1-ggm#95

Open
GibsonGM12 wants to merge 3 commits intoLIDR-academy:mainfrom
GibsonGM12:feature-entrega1-ggm
Open

entrega1-ggm#95
GibsonGM12 wants to merge 3 commits intoLIDR-academy:mainfrom
GibsonGM12:feature-entrega1-ggm

Conversation

@GibsonGM12
Copy link

@GibsonGM12 GibsonGM12 commented Jan 24, 2026

📚 Documentación completa del ciclo de vida del software – MetaBuilder

Este Pull Request incorpora la documentación integral del proyecto MetaBuilder, cubriendo todo el ciclo de vida del desarrollo de software, desde la definición funcional hasta los lineamientos de operación y mantenimiento.

Alcance del trabajo

Se agregó documentación estructurada y coherente que incluye:

  • 📌 Backlog del proyecto

    • Historias de usuario con criterios de aceptación
    • Tickets de trabajo asociados y priorizados
  • 🏗️ Arquitectura del sistema

    • Diagrama de arquitectura
    • Descripción de componentes principales
    • Descripción de alto nivel del proyecto y estructura de ficheros
  • 🗄️ Modelo de datos

    • Entidades, relaciones y consideraciones técnicas
    • Diagrama del modelo de datos
  • 🔌 Especificación de la API

    • Endpoints, convenciones, autenticación y manejo de errores
  • 🚀 Infraestructura y despliegue

    • Entornos
    • Estrategia de CI/CD
    • Configuración, escalabilidad y monitoreo
  • 🔐 Seguridad

    • Principios de seguridad
    • Autenticación, autorización y protección de datos
  • 🧪 Estrategia de testing

    • Pruebas unitarias, integración y E2E
    • Automatización y criterios de calidad
  • 🔁 Lineamientos de Pull Requests

    • Convenciones, checklist y proceso de revisión

Objetivo

Establecer una base sólida, clara y escalable para el desarrollo de MetaBuilder, facilitando:

  • Onboarding de nuevos desarrolladores
  • Alineación técnica y funcional del equipo
  • Mantenimiento y evolución del sistema
  • Estandarización de procesos de desarrollo

No se incluyen cambios funcionales ni de código productivo; este PR es 100% documentación.


Quedo atento a comentarios o sugerencias para iterar sobre la documentación.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Spanish specification and planning pack covering system objectives, architecture proposals, metadata-driven design options, API and frontend outlines, workflows, diagrams, testing strategy, and phased delivery plan.
    • Introduced a detailed backlog/documentation framework with roles, templates, sequencing rules, and structured outputs for project artifacts.
    • Added repository metadata including the public repo link.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

This PR adds comprehensive project planning and documentation for a metadata-driven, low-code platform: a new Spanish specification file (prompt_base.md) detailing architecture, stack, DB design, APIs, frontend, and roadmap; an expanded prompts/backlog framework (prompts.md) defining roles, workflows, and deliverables; and repository metadata (repository.md).

Changes

Cohort / File(s) Summary
Project specification
prompt_base.md
(+219/-0): New, multi-section Spanish specification and planning document describing objectives, stack (C#/.NET, React, PostgreSQL, Keycloak), metadata-driven architecture (EAV vs dynamic tables), DB logical design, backend API contracts, frontend component structure, workflow diagrams (Mermaid), phased implementation plan, testing strategy, and output requirements.
Prompts & backlog framework
prompts.md
(+372/-51): Replaces a short prompt with a full backlog-generation and documentation framework. Introduces roles (Product Manager, Software Analyst, Project Planner), required sources, a rule-based workflow, mandated deliverables (project ficha, product overview, architecture, data model, APIs, user stories, tickets, PRs, roadmap), templates and file organization under @documentation, and Spanish-neutral output constraints.
Repository metadata
repository.md
(+3/-0): Adds repository metadata (visibility: Public, URL: https://github.com/GibsonGM12/MetaBuilder).

Sequence Diagram(s)

(omitted — documentation/planning changes only; no new multi-component runtime control flow introduced)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Poem

🐇 Salté entre esquemas y líneas a soñar,

Dibujé tablas, rutas y un API en el mar,
En español tejí el mapa para crear,
Metadata, planes y un backlog por andar,
¡Brinco y dejo pistas para quien lo quiera compilar!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'entrega1-ggm' is vague and does not clearly convey the substantial documentation additions (backlog, architecture, data model, API specs, infrastructure, security, testing, and PR guidelines) that constitute the main changes in this pull request. Use a descriptive title that reflects the primary change, such as 'Add comprehensive project documentation (backlog, architecture, API specs, testing strategy)' or 'Document MetaBuilder: architecture, APIs, data model, and development guidelines'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@prompts.md`:
- Around line 312-340: Replace the bolded section titles (e.g., "**Historia de
Usuario 1**", "**Ticket 1**", "**Pull Request 1**" and their numbered variants)
with markdown headings using "###" so they become "### Historia de Usuario 1",
"### Ticket 1", "### Pull Request 1" etc.; update each occurrence in the block
between "## 6. Tickets de Trabajo" and "## 7. Pull Requests" (and the sections
under 7) to use consistent heading syntax to satisfy markdownlint rule MD036
while keeping the existing text unchanged.
🧹 Nitpick comments (4)
prompts.md (4)

19-136: Alinea el orden y la numeración de entregables con el índice.

Aquí se pide un orden 1–8 (y PRs opcional), pero el índice usa 0–7 y siempre incluye PRs. Esto puede generar salidas inconsistentes. Unifica la numeración y aclara si “Pull Requests” es opcional también en el índice.

♻️ Propuesta de ajuste
-OUTPUT: Genera los siguientes entregables, EN ESTE ORDEN:
+OUTPUT: Genera los siguientes entregables, EN ESTE ORDEN (si no aplica, omite la sección correspondiente):

-## Índice
-0. [Ficha del proyecto](`#0-ficha-del-proyecto`)
-1. [Descripción general del producto](`#1-descripción-general-del-producto`)
-2. [Arquitectura del sistema](`#2-arquitectura-del-sistema`)
-3. [Modelo de datos](`#3-modelo-de-datos`)
-4. [Especificación de la API](`#4-especificación-de-la-api`)
-5. [Historias de usuario](`#5-historias-de-usuario`)
-6. [Tickets de trabajo](`#6-tickets-de-trabajo`)
-7. [Pull requests](`#7-pull-requests`)
+## Índice
+1. [Ficha del proyecto](`#1-ficha-del-proyecto`)
+2. [Descripción general del producto](`#2-descripción-general-del-producto`)
+3. [Arquitectura del sistema](`#3-arquitectura-del-sistema`)
+4. [Modelo de datos](`#4-modelo-de-datos`)
+5. [Especificación de la API](`#5-especificación-de-la-api`)
+6. [Historias de usuario](`#6-historias-de-usuario`)
+7. [Tickets de trabajo](`#7-tickets-de-trabajo`)
+8. [Pull requests (opcional)](`#8-pull-requests-opcional`)

63-76: Evita conflicto entre “todas las APIs necesarias” y “máximo 3 endpoints”.

Se solicita definir todas las APIs necesarias, pero luego el template limita a 3 endpoints. Esto puede truncar el diseño real. Decide una sola regla.

♻️ Propuesta de ajuste
-> Si tu backend se comunica a través de API, describe los endpoints principales (máximo 3) en formato OpenAPI.
+> Si tu backend se comunica a través de API, describe los endpoints principales en formato OpenAPI.
+> Si necesitas limitar el detalle, incluye “Top 3 críticos” y agrega una lista resumida del resto.

Also applies to: 302-305


193-283: Inconsistencia de rutas de salida vs carpeta destino.

Se pide escribir en @documentation/Infra y @documentation/Test, pero las salidas esperadas están en @documentation/*.md (raíz). Eso genera ubicaciones ambiguas.

♻️ Propuesta de ajuste
-Salida esperada:
-- Crear/actualizar el archivo: `@documentation/infraestructura-despliegue.md`
+Salida esperada:
+- Crear/actualizar el archivo: `@documentation/Infra/infraestructura-despliegue.md`

-Salida esperada:
-- Crear/actualizar el archivo: `@documentation/seguridad.md`
+Salida esperada:
+- Crear/actualizar el archivo: `@documentation/Infra/seguridad.md`

-Salida esperada:
-- Crear/actualizar el archivo: `@documentation/tests.md`
+Salida esperada:
+- Crear/actualizar el archivo: `@documentation/Test/tests.md`

120-122: Clarifica la estructura de archivos y carpetas en @documentation.

Indica @documentation/readme.md y además carpetas por sección, pero no define el nombre exacto de cada carpeta ni cómo se relaciona con el índice. Esto puede producir salidas inconsistentes.

♻️ Propuesta de ajuste
-Todo esto lo vas a generar dentro de la carpeta `@documentation` , y el formato que te comparti tendra dentro de esta carpeta el nombre de "readme.md", asi mismo espero que por cada seccion anterior antes comentada hagas carpetas dentro de `@documentation` con el titulo y el contenido de cada seccion...
+Todo esto se genera dentro de `@documentation`:
+- Archivo principal: `@documentation/readme.md` (con el índice y resumen).
+- Carpetas por sección: `@documentation/01-ficha`, /02-descripcion, /03-arquitectura, /04-modelo-datos, /05-api, /06-historias, /07-tickets, /08-prs (si aplica).

Comment on lines 312 to 340
**Historia de Usuario 1**

**Prompt 3:**
**Historia de Usuario 2**

**Historia de Usuario 3**

---

### 6. Tickets de Trabajo
## 6. Tickets de Trabajo

> Documenta 3 de los tickets de trabajo principales del desarrollo, uno de backend, uno de frontend, y uno de bases de datos. Da todo el detalle requerido para desarrollar la tarea de inicio a fin teniendo en cuenta las buenas prácticas al respecto.

**Prompt 1:**
**Ticket 1**

**Prompt 2:**
**Ticket 2**

**Prompt 3:**
**Ticket 3**

---

### 7. Pull Requests
## 7. Pull Requests

> Documenta 3 de las Pull Requests realizadas durante la ejecución del proyecto

**Pull Request 1**

**Pull Request 2**

**Pull Request 3**
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Usa encabezados en lugar de énfasis para cumplir markdownlint (MD036).

Las líneas con Historia de Usuario / Ticket / Pull Request están en negrita y no como heading. Cambia a ### para consistencia.

🛠️ Propuesta de ajuste
-**Historia de Usuario 1**
+### Historia de Usuario 1

-**Historia de Usuario 2**
+### Historia de Usuario 2

-**Historia de Usuario 3**
+### Historia de Usuario 3

-**Ticket 1**
+### Ticket 1

-**Ticket 2**
+### Ticket 2

-**Ticket 3**
+### Ticket 3

-**Pull Request 1**
+### Pull Request 1

-**Pull Request 2**
+### Pull Request 2

-**Pull Request 3**
+### Pull Request 3
🧰 Tools
🪛 LanguageTool

[grammar] ~320-~320: Corrige la mayúscula.
Context: ...a de Usuario 3** --- ## 6. Tickets de Trabajo > Documenta 3 de los tickets de trabajo pr...

(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)


[grammar] ~322-~322: Elimina la puntuación
Context: ...arrollo, uno de backend, uno de frontend, y uno de bases de datos. Da todo el det...

(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)


[grammar] ~322-~322: Agrega un signo de puntuación.
Context: ...o para desarrollar la tarea de inicio a fin teniendo en cuenta las buenas prácticas...

(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_PUNCTUATION)


[grammar] ~334-~334: Aquí puede haber un error.
Context: ...izadas durante la ejecución del proyecto Pull Request 1 Pull Request 2 **...

(QB_NEW_ES)

🪛 markdownlint-cli2 (0.18.1)

312-312: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


314-314: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


316-316: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


324-324: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


326-326: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


328-328: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


336-336: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


338-338: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


340-340: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents
In `@prompts.md` around lines 312 - 340, Replace the bolded section titles (e.g.,
"**Historia de Usuario 1**", "**Ticket 1**", "**Pull Request 1**" and their
numbered variants) with markdown headings using "###" so they become "###
Historia de Usuario 1", "### Ticket 1", "### Pull Request 1" etc.; update each
occurrence in the block between "## 6. Tickets de Trabajo" and "## 7. Pull
Requests" (and the sections under 7) to use consistent heading syntax to satisfy
markdownlint rule MD036 while keeping the existing text unchanged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant