Skip to content

Endurecer reglas de markdownlint #140

Description

@Scot3004

Plan progresivo de endurecimiento de reglas de markdownlint para mejorar la calidad de Markdown en el proyecto.

Contexto

El issue #139 ya implementó markdownlint con una configuración única unificada usando severity levels. La mayoría de reglas están configuradas como warning para mantener compatibilidad con contenido existente.

Este issue se enfoca en el siguiente paso: auditar y endurecer estas reglas progresivamente, convirtiendo warnings a errors según sea justificado.

Objetivo

Reducir gradualmente el número de warnings y aumentar el número de errors, haciendo que la validación de Markdown sea más estricta de forma progresiva.

Enfoque

  1. Auditar reglas actuales: Identificar cuáles warnings podrían convertirse a errors
  2. Planificar endurecimiento por fases: Cambios incrementales, no disruptivos
  3. Implementar por PRs discretas: Cada cambio en una PR separada con justificación clara
  4. Documentar decisiones: Actualizar ADR 009 y .markdownlint.jsonc con el razonamiento

Criterios para convertir warning → error

Una regla debería cambiar a error si:

  • Mejora significativamente la calidad y consistencia de markdown
  • No rompe compilación para la mayoría del contenido existente
  • Es fácil de corregir automáticamente con npm run lint:md:fix
  • Tiene un propósito claro y está bien documentado en comentarios JSONC

Tareas

  • Auditar cada regla de warning actual en .markdownlint.jsonc
  • Identificar candidatos para Fase 1 de endurecimiento
  • Implementar Fase 1: convertir warnings → errors
  • Recopilar feedback y ajustar según sea necesario
  • Planificar Fase 2 si es apropiado

Notas

  • Este issue no es urgente: es trabajo de mejora continua
  • Priorizar reglas que afecten legibilidad general (p.ej. espacios alrededor de encabezados)
  • Mantener compatibilidad con contenido generado automáticamente (p.ej. licenses, markdown generado)
  • Referencia: ADR 009 — Validación de Markdown

Relacionado: Issue #139 (implementación inicial de markdownlint)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions