From 78e259b6ca33016688d23a59306560fa6b25bb64 Mon Sep 17 00:00:00 2001 From: Ochoa-Stack Date: Fri, 10 Jul 2026 13:13:40 -0600 Subject: [PATCH] Reapply "chore(gobernanza): establecer fundamentos operativos y de CI" This reverts commit de1ebfcf5f3a1339459c8a8ee28c3f9db7a67a86. --- .env.example | 11 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 19 +++++++++++++ .github/workflows/ci.yml | 12 ++++---- CHANGELOG.md | 16 +++++++++++ CODE_OF_CONDUCT.md | 47 +++++++++++++++++++++++++++++++ CONTRIBUTING.md | 41 +++++++++++++++++++++++++++ SECURITY.md | 17 +++++++++++ docs/adr/001-mvc-con-servicios.md | 24 ++++++++++++++++ 8 files changed, 180 insertions(+), 7 deletions(-) create mode 100644 .env.example create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md create mode 100644 docs/adr/001-mvc-con-servicios.md diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..286ebf4 --- /dev/null +++ b/.env.example @@ -0,0 +1,11 @@ +# Configuración de Base de Datos +DB_HOST=127.0.0.1 # Host de la base de datos MariaDB +DB_PORT=3306 # Puerto de la base de datos +DB_NAME=salitre # Nombre de la base de datos +DB_USER=root # Usuario de la base de datos +DB_PASS= # Contraseña del usuario + +# Configuración de la Aplicación +APP_ENV=local # Entorno de ejecución (local, testing, production) +APP_URL=http://localhost # URL base de la aplicación +APP_DEBUG=true # Activar o desactivar modo depuración diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..19a8c4d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,19 @@ +## Descripción del cambio + +Por favor, incluye un resumen de los cambios y el issue relacionado si lo hay. Incluye también contexto y motivación relevantes. + +## Tipo de cambio + +- [ ] `feat`: Nueva característica. +- [ ] `fix`: Corrección de error. +- [ ] `chore`: Mantenimiento, refactorización, actualización de tareas CI o documentación. +- [ ] `docs`: Cambios en la documentación. +- [ ] Otro: + +## Checklist de auto-revisión + +- [ ] ¿El código pasa el análisis estático de PHPStan (al nivel configurado)? +- [ ] ¿El código cumple con los estándares de estilo PHPCS? +- [ ] ¿Se ha actualizado el archivo `CHANGELOG.md` con los cambios relevantes? +- [ ] ¿Se ha revisado si este cambio introduce nueva deuda técnica? +- [ ] ¿Se han seguido los estándares de seguridad listados en `SECURITY.md`? diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ee7c627..b57ee38 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,11 +1,11 @@ name: Continuous Integration -# Configuramos los disparadores para nuestras ramas principales +# Configuración de los disparadores para las ramas principales on: push: - branches: [ "master", "develop" ] + branches: [ "main", "develop" ] pull_request: - branches: [ "master", "develop" ] + branches: [ "main", "develop" ] jobs: audit: @@ -21,12 +21,10 @@ jobs: with: php-version: '8.2' tools: composer - # Activamos las extensiones críticas para conectar la lógica extensions: pdo_mysql - - name: Instalamos las dependencias de control de calidad + - name: Instalación de las dependencias de control de calidad run: composer install --prefer-dist --no-progress - - name: Ejecutamos el análisis estático y formateo estricto - # Si PHPStan detecta errores, bloquearemos el merge automáticamente + - name: Ejeución de el análisis estático y formateo estricto run: composer run check diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..309f0c4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.0] - 2024-05-15 + +### Added + +- Lanzamiento inicial de la plataforma de reservas Salitre. +- Estructura base del proyecto con arquitectura MVC con Servicios. +- Integración continua básica (CI) con validación estática de PHP. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1ed799a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,47 @@ +# Código de Conducta de los Contribuyentes + +## Nuestro Compromiso + +Nosotros, como miembros, contribuyentes y administradores, nos comprometemos a hacer de la participación en nuestra comunidad una experiencia libre de acoso para todo el mundo, independientemente de la edad, dimensión corporal, discapacidad visible o invisible, etnia, características sexuales, identidad y expresión de género, nivel de experiencia, educación, nivel socioeconómico, nacionalidad, apariencia personal, raza, religión o identidad u orientación sexual. + +Nos comprometemos a actuar e interactuar de maneras que contribuyan a una comunidad abierta, acogedora, diversa, inclusiva y sana. + +## Nuestros Estándares + +Ejemplos de comportamiento que contribuyen a crear un ambiente positivo para nuestra comunidad: + +- Demostrar empatía y amabilidad ante otras personas. +- Respeto a las diferentes opiniones, puntos de vista y experiencias. +- Dar y aceptar con gracia la retroalimentación constructiva. +- Aceptar la responsabilidad y disculparse ante quienes se vean afectados por nuestros errores, aprendiendo de la experiencia. +- Centrarse en lo que sea mejor no sólo para nosotros como individuos, sino para la comunidad en general. + +Ejemplos de comportamiento inaceptable: + +- El uso de lenguaje o imágenes sexualizadas, y aproximaciones o atenciones sexuales de cualquier tipo. +- Comentarios despectivos (_trolling_), insultos o ataques personales o políticos. +- El acoso en público o privado. +- Publicar información privada de otras personas, tales como direcciones físicas o correos electrónicos, sin su permiso explícito. +- Otras conductas que puedan ser razonablemente consideradas inapropiadas en un entorno profesional. + +## Responsabilidades de Aplicación + +Los administradores de la comunidad son responsables de aclarar y hacer cumplir nuestros estándares de comportamiento aceptable y tomarán acciones apropiadas y justas en respuesta a cualquier comportamiento que consideren inapropiado, amenazante, ofensivo o dañino. + +Los administradores de la comunidad tendrán el derecho y la responsabilidad de eliminar, editar o rechazar comentarios, commits, código, ediciones de páginas de wiki, _issues_ y otras contribuciones que no se alineen con este Código de Conducta, y comunicarán las razones para las decisiones de moderación cuando sea apropiado. + +## Alcance + +Este Código de Conducta aplica tanto a todos los espacios de la comunidad como a los espacios públicos cuando un individuo esté en representación de la comunidad. Ejemplos de esto incluyen el uso de la cuenta oficial de correo electrónico, publicaciones a través de las redes sociales oficiales, o las presentaciones con personas designadas en eventos en línea o no. + +## Aplicación + +Casos de comportamiento abusivo, acosador o inaceptable de otro modo podrán ser reportados a los administradores de la comunidad responsables del cumplimiento del código. Todas las quejas serán revisadas e investigadas, y resultarán en una respuesta que se considere necesaria y apropiada a las circunstancias. La comunidad de administradores está obligada a mantener la confidencialidad de la persona que reportó el incidente. Detalles específicos acerca de las políticas de aplicación pueden ser publicados por separado. + +Quienes administren la comunidad y no sigan o apliquen el Código de Conducta de buena fe pueden enfrentarse a repercusiones temporales o permanentes según lo determinen otros miembros del liderazgo de la comunidad. + +## Atribución + +Este Código de Conducta es una adaptación del [Contributor Covenant][homepage], versión 2.1, disponible en https://www.contributor-covenant.org/es/version/2/1/code_of_conduct.html. + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..284fa32 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Guía de Contribución + +Gracias por considerar contribuir a Salitre. Esta guía establece los estándares de ingeniería y gobernanza del proyecto. + +## Flujo de Ramas (Git Flow Simplificado) + +El proyecto utiliza un flujo de trabajo estructurado para garantizar la estabilidad: + +- **`main`**: Rama de producción. Refleja el estado estable y desplegado de la aplicación. +- **`develop`**: Rama de integración. Aquí se unen las nuevas características antes de pasar a producción. +- **Ramas temporales**: Toda contribución debe realizarse en una rama específica, partiendo de `develop`, utilizando los siguientes prefijos: + - `feature/` para funcionalidad nueva. + - `fix/` para corrección de error en desarrollo. + - `hotfix/` para corrección urgente en producción. + - `refactor/` para reorganización sin cambiar comportamiento. + - `chore/` para mantenimiento, dependencias, configuración. + - `docs/` para documentación únicamente. + - `test/` para pruebas nuevas o actualizadas. + - `release/` para preparación de versión para producción. + +Los nombres van en minúsculas, con guiones y sin acentos. + +## Mensajes de Commit (Conventional Commits) + +El proyecto requiere el uso estricto de [Conventional Commits](https://www.conventionalcommits.org/es/v1.0.0/). El formato es el siguiente: + +``` +tipo(alcance): descripción en imperativo +``` + +Tipos permitidos: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`. +Ejemplo: `feat(reservas): añadir validación de disponibilidad por fechas`. + +## Entorno de Desarrollo Local + +El entorno de desarrollo está encapsulado mediante Docker. Para inicializar el proyecto: + +1. Copiar el archivo de variables de entorno: `cp .env.example .env` +2. Configurar los valores en `.env` (si difieren de los predeterminados). +3. Levantar los contenedores: `docker compose up -d` +4. Ejecutar las migraciones y seeders (si aplica). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..0e10b79 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ +# Política de Seguridad + +Salitre es un proyecto de portafolio que aplica los más altos estándares de seguridad en aplicaciones web PHP nativas. + +## Reporte de Vulnerabilidades + +Dado que este repositorio es público, **NO** reporte vulnerabilidades mediante Issues convencionales. Las vulnerabilidades deben reportarse abriendo un Issue privado directamente en GitHub. Esto permite revisar y parchear el fallo de manera segura. + +## Prácticas de Seguridad + +El proyecto implementa de forma estricta las siguientes medidas: + +- **Prevención de Inyección SQL**: Uso exclusivo de la extensión PDO con _prepared statements_ (sentencias preparadas) para todas las consultas. +- **Gestión de Contraseñas**: Uso nativo de `password_hash()` (algoritmos seguros como bcrypt o Argon2) y `password_verify()` para el almacenamiento y verificación de credenciales. +- **Prevención de CSRF**: Generación y validación de tokens CSRF efímeros por sesión/formulario en cada petición mutante (POST, PUT, DELETE). +- **Seguridad de Sesiones**: Regeneración constante del ID de sesión (`session_regenerate_id()`) para mitigar fijación de sesión y cookies seguras. +- **Hardening del Servidor**: Configuración estricta de directivas de seguridad en Nginx (ocultación de versión, cabeceras de seguridad HTTP, denegación de acceso a archivos ocultos/sensibles). diff --git a/docs/adr/001-mvc-con-servicios.md b/docs/adr/001-mvc-con-servicios.md new file mode 100644 index 0000000..23907fb --- /dev/null +++ b/docs/adr/001-mvc-con-servicios.md @@ -0,0 +1,24 @@ +# 001. Arquitectura MVC con Servicios y Repositorios + +Date: 2026-07-10 + +## Status + +Accepted + +## Contexto + +El proyecto requiere una clara separación de responsabilidades para garantizar la mantenibilidad y testabilidad del código base. Sin embargo, existe una restricción estricta de cero dependencias en *runtime*, lo que impide el uso de contenedores de inyección de dependencias complejos o frameworks externos que habiliten una Arquitectura Hexagonal pura sin agregar un volumen significativo de código repetitivo de infraestructura. + +## Decisión + +Se adopta el patrón "MVC con Servicios y Repositorios" como compromiso arquitectónico: + +- **Controladores (Controllers):** Únicamente gestionan el ciclo HTTP (recibir Request, delegar a servicios, y retornar Response/Vista). +- **Servicios (Services):** Encapsulan de forma aislada toda la lógica de negocio y las reglas del dominio. +- **Repositorios (Repositories):** Abstraen las consultas y la persistencia hacia la base de datos (utilizando PDO de forma nativa). + +## Consecuencias + +- **Positivas:** Se mantiene la claridad arquitectónica y se facilita en gran medida la testabilidad (los servicios se pueden probar independientemente del ciclo HTTP) sin el *overhead* de desarrollar o importar capas de infraestructura complejas. +- **Negativas:** Se sacrifica la independencia absoluta del motor de base de datos. Existe un acoplamiento inherente a PDO y MariaDB en la capa de repositorios que requeriría reescritura manual en caso de migrar a otro paradigma de almacenamiento de datos.