docs(guidelines): establecimiento de los lineamientos del proyecto y documentación de directorios#2
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Este PR agrega documentación base del proyecto para definir reglas operativas (flujo de trabajo, commits y ramas) y para delimitar el propósito/alcance de directorios clave (frontend, backend, data, scripts y capas del backend), con el objetivo de estandarizar cómo se contribuye y cómo se entiende la arquitectura.
Changes:
- Se incorpora
CONTRIBUTING.mdcon convenciones de ramas/commits y lineamientos de revisión/comentarios. - Se agregan guías operativas en
docs/(Git diario y configuración de entorno local) y una descripción de arquitectura. - Se añaden
README.mdpor directorio para documentar propósito, estructura y límites.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/README.md | Describe el propósito de scripts/ y cómo ejecutar utilidades manuales. |
| frontend/README.md | Documenta estructura de assets/vistas y reglas de separación frontend/backend. |
| docs/GUIA_GIT.md | Guía práctica de comandos y flujo de trabajo Git usado por el equipo. |
| docs/GUIA_ENTORNO.md | Pasos para preparar el entorno local (Python/Git/venv/.env). |
| docs/ARQUITECTURA.md | Visión de arquitectura y organización del repositorio/capas del backend. |
| data/README.md | Define el contenido de data/ y cómo mantener diccionarios/samples. |
| CONTRIBUTING.md | Estándares de colaboración (ramas, commits, reglas no negociables). |
| backend/README.md | Explica la estructura del backend y responsabilidades generales. |
| backend/clients/README.md | Delimita qué va en clientes de APIs externas y su rol esperado. |
| backend/app/services/README.md | Define responsabilidad de servicios (lógica de negocio) y ejemplos. |
| backend/app/repositories/README.md | Define responsabilidad de repositorios (acceso a datos) y base repository. |
| backend/app/models/README.md | Describe el rol de modelos y referencia a documentación/diagramas. |
| backend/app/controllers/README.md | Define responsabilidad de controladores/Blueprints y endpoints por dominio. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+25
to
+31
| # Nos aseguramos de estar en la carpeta backend con el entorno activo | ||
| cd backend | ||
| source .venv/bin/activate # Mac / Linux | ||
| .venv\Scripts\activate # Windows | ||
|
|
||
| # Corremos el script desde la raiz del repositorio | ||
| python scripts/nombre_del_script.py |
Comment on lines
+3
to
+5
| Aqui viven herramientas de uso manual para tareas de mantenimiento | ||
| y configuracion del proyecto. Estos scripts no forman parte de la | ||
| aplicacion y no se ejecutan automaticamente. |
Comment on lines
+3
to
+4
| Aqui vive todo lo que el usuario ve y con lo que interactua: las vistas | ||
| HTML, los estilos CSS y la logica JavaScript del cliente. |
| └── views/ Un archivo HTML por cada pantalla de la aplicacion | ||
| ``` | ||
|
|
||
| ## Como organizamos los estilos |
| - `css/pages/` - estilos especificos de cada pantalla. | ||
| - `css/main.css` - punto de entrada que importa todo lo anterior. | ||
|
|
||
| ## Como organizamos el JavaScript |
Comment on lines
+8
to
+10
| Git guarda el historial de todos los cambios que hacemos al codigo. | ||
| Cada vez que guardamos un cambio con `commit` quedamos un registro de | ||
| que cambio, quien lo hizo y cuando. |
Comment on lines
+82
to
+90
| **6. Corremos el servidor de desarrollo** | ||
|
|
||
| ```bash | ||
| python run.py | ||
| ``` | ||
|
|
||
| Si todo esta bien veremos un mensaje indicando que Flask esta corriendo, | ||
| generalmente en http://localhost:5000 | ||
|
|
Comment on lines
+20
to
+22
| El archivo `run.py` inicia el servidor. La aplicacion se construye | ||
| en `app/__init__.py` usando el patron application factory, que permite | ||
| crear instancias independientes para desarrollo, produccion y pruebas. |
| `category`, `city`, `skill`, `job`, `job_skill`, `user`, `alert`, | ||
| `trend_snapshot`, `backup`. | ||
|
|
||
| El diagrama entidad-relacion completo esta en `docs/diagramas/er.png`. |
|
|
||
| Escribimos en primera persona del plural, en español, sin tecnicismos, | ||
| sin emojis y sin numerar los pasos. Aplica a todos los lenguajes del | ||
| proyecto: Python, JavaScript, CSS e HTML. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/project-guidelines
Descripción
Se integran 13 archivos de documentación para establecer las reglas operativas, el flujo de trabajo y los límites arquitectónicos del sistema. Esta ronda es estrictamente documental y no altera ni introduce lógica de aplicación ejecutable.
El bloque consta de:
CONTRIBUTING.mden la raíz (convenciones de ramas, commits y revisión de código).docs/): Guías de entorno local, uso de Git y arquitectura global.README.mddistribuidos en los nodos críticos (frontend/,backend/, capas hexagonales,data/yscripts/) que delimitan el propósito y las restricciones lógicas de cada directorio.Tipo de cambio
Cómo probar
git checkout develop && git pull origin developfind . -name "*.md" -not -path "./.git/*" | sortCONTRIBUTING.mdydocs/ARQUITECTURA.mden el editor para confirmar el renderizado correcto del Markdown y la integridad de las tablas.Checklist