From 0d6711458dc127e3fd41e5e7ec88095dd8e5dc51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Arnulfo=20R=2E=20H=2E?= Date: Sun, 27 Sep 2026 09:43:04 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20a=C3=B1adir=20plantillas=20y=20gu=C3=AD?= =?UTF-8?q?a=20de=20contribuci=C3=B3n=20con=20CODEOWNERS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CODEOWNERS | 6 ++++ .github/ISSUE_TEMPLATE/cambio-contenido.md | 28 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/error-sitio.md | 33 ++++++++++++++++++ .github/ISSUE_TEMPLATE/mejora-tecnica.md | 25 ++++++++++++++ .github/pull_request_template.md | 31 +++++++++++++++++ CONTRIBUTING.md | 40 ++++++++++++++++++++++ README.md | 4 +++ 8 files changed, 172 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/cambio-contenido.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/error-sitio.md create mode 100644 .github/ISSUE_TEMPLATE/mejora-tecnica.md create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..4a6d51b --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,6 @@ +# Responsables de revisión del sitio. +# GitHub usa este archivo desde la rama de destino del PR. +/2026/ @yosef7 +/netlify.toml @yosef7 +/scripts/ @yosef7 +/.github/ @yosef7 diff --git a/.github/ISSUE_TEMPLATE/cambio-contenido.md b/.github/ISSUE_TEMPLATE/cambio-contenido.md new file mode 100644 index 0000000..eb55c77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cambio-contenido.md @@ -0,0 +1,28 @@ +--- +name: Cambio de contenido +about: Propón una corrección o actualización del contenido público. +title: "[Contenido] " +--- + +## Página y edición afectadas + + + +## Texto o contenido actual + +## Cambio propuesto + + + +## Motivo y fuente pública + + + +## Criterios de aceptación + +- [ ] + +Consulta la [guía de contribución](https://github.com/pythonpanama/pycon_panama_web/blob/main/CONTRIBUTING.md). Para consultas sobre el evento que no sean del sitio, escribe a [pyconpanama@gmail.com](mailto:pyconpanama@gmail.com). + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4ae1c41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Consultas sobre PyCon Panamá + url: mailto:pyconpanama@gmail.com + about: Para consultas sobre el evento que no sean errores o cambios del sitio web. diff --git a/.github/ISSUE_TEMPLATE/error-sitio.md b/.github/ISSUE_TEMPLATE/error-sitio.md new file mode 100644 index 0000000..8253045 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/error-sitio.md @@ -0,0 +1,33 @@ +--- +name: Error en el sitio +about: Informa un fallo de navegación, visualización o funcionamiento. +title: "[Error] " +--- + +## Página y edición afectadas + + + +## Pasos para reproducir + +1. +2. +3. + +## Resultado esperado + +## Resultado observado + +## Entorno + +- Dispositivo y sistema operativo: +- Navegador y versión: +- ¿Ocurre en móvil, escritorio o ambos?: + +## Evidencia + + + +Consulta la [guía de contribución](https://github.com/pythonpanama/pycon_panama_web/blob/main/CONTRIBUTING.md). Para consultas sobre el evento que no sean del sitio, escribe a [pyconpanama@gmail.com](mailto:pyconpanama@gmail.com). + + diff --git a/.github/ISSUE_TEMPLATE/mejora-tecnica.md b/.github/ISSUE_TEMPLATE/mejora-tecnica.md new file mode 100644 index 0000000..92bedc9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/mejora-tecnica.md @@ -0,0 +1,25 @@ +--- +name: Mejora técnica +about: Propón mejoras de accesibilidad, rendimiento, mantenimiento o herramientas. +title: "[Mejora] " +--- + +## Problema que se quiere resolver + +## Propuesta + +## Alcance + + + +## Alternativas consideradas + +## Criterios de aceptación y validación + + + +- [ ] + +Consulta la [guía de contribución](https://github.com/pythonpanama/pycon_panama_web/blob/main/CONTRIBUTING.md). Para consultas sobre el evento que no sean del sitio, escribe a [pyconpanama@gmail.com](mailto:pyconpanama@gmail.com). + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7235c96 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +## Cambio y motivo + + + +## Issue relacionado + + + +## Páginas, edición y archivos afectados + +## Validación + + + +- [ ] Ejecuté `python3 scripts/validate_site.py` y registré el resultado. +- [ ] Ejecuté `node --test tests/*.cjs` y registré el resultado. +- [ ] Ejecuté `git diff --check` sin errores. +- [ ] Revisé las páginas afectadas en escritorio y móvil. +- [ ] Comprobé navegación, enlaces, imágenes, contraste, foco de teclado y zoom cuando aplica. +- [ ] Revisé sitemap, canonical y metadatos sociales si cambié contenido o rutas. + +### Resultados y evidencia + + + +## Guía de contribución + +Consulta [CONTRIBUTING.md](https://github.com/pythonpanama/pycon_panama_web/blob/main/CONTRIBUTING.md) y la [validación del README](https://github.com/pythonpanama/pycon_panama_web/blob/main/README.md#validar-antes-de-proponer-cambios). + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e8c2c2e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contribuir al sitio de PyCon Panamá + +Última actualización: 27 de septiembre de 2026. + +Este repositorio mantiene el sitio público de PyCon Panamá. La edición activa es `2026/`; `2025/` y `2024/` se conservan como archivo y solo admiten correcciones puntuales. + +## Abrir un issue + +Busca primero si el problema ya está reportado. Elige una plantilla de **error en el sitio**, **cambio de contenido** o **mejora técnica** y completa sus apartados con la página o archivo afectado, el motivo y el resultado esperado. Para contenido del evento, aporta una fuente pública e indica si falta confirmación de la organización. + +Las consultas del evento que no correspondan al sitio se atienden en [pyconpanama@gmail.com](mailto:pyconpanama@gmail.com). + +## Preparar un cambio + +1. Sigue el [inicio rápido](README.md#inicio-rápido) para servir el sitio desde la raíz. +2. Crea una rama desde `main` actualizado, con un nombre descriptivo y un único propósito. +3. Aplica las indicaciones de [Cambiar el sitio](README.md#cambiar-el-sitio) y [Contribuir](README.md#contribuir). Mantén pequeños los commits y explica el motivo del cambio. +4. Conserva fuera del repositorio los datos privados, credenciales y SQL internos: Netlify publica la raíz completa. Publica únicamente información del evento confirmada por la organización. + +## Validar y abrir un PR + +Ejecuta desde la raíz, con Python 3 y Node.js disponibles: + +```bash +python3 scripts/validate_site.py +node --test tests/*.cjs +git diff --check +``` + +Node.js se usa para las pruebas; el sitio estático no requiere compilación. Consulta [Validar antes de proponer cambios](README.md#validar-antes-de-proponer-cambios) para las comprobaciones HTTP, visuales en escritorio y móvil, y de enlaces externos. Si no tienes red, usa `python3 scripts/validate_site.py --skip-external` y declara esa limitación. + +Abre el PR hacia `main`, completa la plantilla e incluye el issue, las páginas o archivos afectados y los resultados. Explica cualquier fallo o comprobación que no aplique. Revisa el preview de Netlify cuando esté disponible. + +## Revisión y publicación + +[CODEOWNERS](.github/CODEOWNERS) identifica a quien revisa `2026/`, `netlify.toml`, `scripts/` y `.github/`. GitHub utiliza el archivo de la rama de destino para solicitar revisiones; comenzará a hacerlo cuando este archivo se integre en `main`. + +CODEOWNERS no impone por sí solo una aprobación obligatoria: esa exigencia se configura en las reglas de protección de la rama con **Require review from Code Owners**. Consulta la [documentación de GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). La integración y la verificación de producción siguen el flujo de [Despliegue](README.md#despliegue). + +Respeta el [Código de Conducta](2026/codigo_conducta.html) en todas las interacciones del proyecto. diff --git a/README.md b/README.md index 82aa4d5..4e10cc0 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,10 @@ No modifiques `netlify.toml` para cambiar la edición activa ni para publicar ru ## Contribuir +Última actualización: 27 de septiembre de 2026. + +Consulta la [guía de contribución](CONTRIBUTING.md) para abrir issues, preparar un PR y solicitar revisión. + Las contribuciones son bienvenidas, especialmente correcciones de contenido, accesibilidad, enlaces y mantenimiento del sitio. - Usa una rama con un nombre descriptivo y commits pequeños que expliquen el cambio.