From f7850d5d6ea5377aea84c7eadbaf38c0a279258d Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 30 May 2026 07:53:51 +0000 Subject: [PATCH] =?UTF-8?q?ci:=20a=C3=B1ade=20workflow=20de=20validaci?= =?UTF-8?q?=C3=B3n=20de=20Markdown?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - .github/workflows/markdown-lint.yml: valida formato Markdown en push/PR con markdownlint-cli2 (solo afecta a este repo; los workflows no se heredan) - .markdownlint.jsonc: config adaptada a nuestro estilo (HTML inline, tablas compactas, pies en cursiva permitidos) - Corrige formato real en CONTRIBUTING.md (fences) y PULL_REQUEST_TEMPLATE.md (línea en blanco duplicada) para pasar el lint en verde --- .github/PULL_REQUEST_TEMPLATE.md | 1 - .github/workflows/markdown-lint.yml | 34 +++++++++++++++++++++++++++++ .markdownlint.jsonc | 25 +++++++++++++++++++++ CONTRIBUTING.md | 6 ++++- 4 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/markdown-lint.yml create mode 100644 .markdownlint.jsonc diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e77bbdf..b18c2e8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,6 @@ - ## 🔗 Issue relacionado · Related issue diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..6833893 --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,34 @@ +# Valida el formato de todos los archivos Markdown del repositorio. +# Validates the formatting of all Markdown files in the repository. +# Docs: https://github.com/DavidAnson/markdownlint-cli2 + +name: Markdown Lint + +on: + push: + paths: + - "**/*.md" + - ".markdownlint.jsonc" + - ".github/workflows/markdown-lint.yml" + pull_request: + paths: + - "**/*.md" + - ".markdownlint.jsonc" + - ".github/workflows/markdown-lint.yml" + workflow_dispatch: {} + +permissions: + contents: read + +jobs: + markdownlint: + name: Lint Markdown + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Run markdownlint-cli2 + uses: DavidAnson/markdownlint-cli2-action@v19 + with: + globs: "**/*.md" diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..5464710 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,25 @@ +// Configuración de markdownlint para la organización NeoNexAI. +// markdownlint configuration for the NeoNexAI organization. +// Reglas: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md +{ + "default": true, + + // MD013: no limitamos la longitud de línea (usamos tablas y URLs largas). + "MD013": false, + + // MD033: permitimos HTML inline (banners
, , badges). + "MD033": false, + + // MD041: la primera línea no tiene por qué ser un H1 (usamos
de cabecera). + "MD041": false, + + // MD024: permitimos encabezados con el mismo texto si están en secciones + // distintas (p. ej. "Confirmaciones" en varias plantillas). + "MD024": { "siblings_only": true }, + + // MD036: permitimos texto en cursiva como pie (p. ej. "_© 2026 NeoNexAI_"). + "MD036": false, + + // MD060: no imponemos estilo de tabla (usamos separadores compactos |---|). + "MD060": false +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa2310f..6ba10e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,17 +19,21 @@ Esta guía aplica por defecto a todos los repositorios de la organización [`@ne 1. Haz **fork** del repositorio y clónalo localmente. 2. Crea una rama descriptiva desde `main`: + ```bash git checkout -b feat/mi-mejora # o fix/, docs/, chore/, refactor/ ``` + 3. Realiza tus cambios siguiendo el estilo del proyecto. 4. Asegúrate de que **pasa el linter y los tests** antes de hacer commit. 5. Haz commits claros siguiendo [Conventional Commits](https://www.conventionalcommits.org/): - ``` + + ```text feat: añade exportación a CSV fix: corrige cálculo del stop ATR docs: actualiza el README de instalación ``` + 6. Abre un **Pull Request** contra `main` rellenando la plantilla. ### 3. Nuestros principios de código (Karpathy principles)