Skip to content

README con cabecera, diagrama y comandos; licencia con titular real - #7

Merged
polmarza merged 1 commit into
mainfrom
claude/readme-y-licencia
Aug 18, 2026
Merged

polmarza merged 1 commit into
mainfrom
claude/readme-y-licencia

Conversation

@polmarza

Copy link
Copy Markdown
Owner

¿Qué se hizo?

Dos cosas sin relación técnica pero que tocaban los mismos archivos: rellenar el titular de la licencia y darle una cabecera decente al README.

LICENSE pasa a Copyright (c) 2026 Pol Marzà. El README estrena cabecera con badges, enlace directo a Usar esta plantilla, un diagrama del ciclo de feature y una tabla con los seis slash commands.

Motivación

La licencia llevaba desde el primer commit con [YEAR] y [AUTHOR] sin rellenar. Un MIT sin titular no concede permisos a nadie con claridad, y este repositorio es público y está hecho precisamente para que la gente lo copie. No era cosmético.

El README sí es presentación, pero de la clase que importa en un repositorio plantilla: la página de inicio es el producto. Además, los diez puntos del protocolo habían crecido hasta leerse como un muro, y los slash commands estaban enterrados dentro de un bullet donde no los encontraba nadie.

Requisitos que cierra

Ninguno. Este repositorio es el andamiaje: no tiene PRD con requisitos propios.

Tipo de cambio

  • Feature
  • Fix
  • Refactor
  • Migración
  • Documentación
  • Configuración

Evidencia

1. Las cuatro URLs de badge resuelven:

$ for u in <las cuatro>; do curl -s -o /dev/null -w '%{http_code} %{content_type}' "$u"; done
200 image/svg+xml; charset=utf-8   .../actions/workflows/cobertura.yml/badge.svg
200 image/svg+xml;charset=utf-8    img.shields.io/badge/licencia-MIT-blue
200 image/svg+xml;charset=utf-8    img.shields.io/badge/pnpm-v11-f69220
200 image/svg+xml;charset=utf-8    img.shields.io/badge/stack-agnóstico-6b7280

2. El badge de CI refleja el estado real, no una imagen fija:

$ curl -s .../cobertura.yml/badge.svg | grep -o "<title>[^<]*</title>"
<title>Cobertura - passing</title>

3. No quedan placeholders en archivos vivos. Los únicos aciertos están en entradas de changelog, que describen el pasado y deben decir lo que decían:

$ grep -rn "\[YEAR\]\|\[AUTHOR\]" . --exclude-dir=.git
.template/changelog/2026-05-14_12-00_mejoras-template-v2.md:20: ... placeholders [YEAR] y [AUTHOR] pendientes de rellenar
.template/changelog/2026-08-18_15-09_readme-con-badges-y-licencia-rellena.md: (4 menciones descriptivas)

4. La verificación de cobertura sigue limpia:

$ node scripts/verificar-cobertura.mjs
Sin fichas de feature todavía: nada que verificar.
$ echo $?
0

Verificación de los requisitos:

No aplica: este PR no cierra ningún requisito de PRD. Lo verificable era el estado de los badges y la ausencia de placeholders, y está arriba.

Checklist

  • Los documentos afectados en docs/ están actualizados — no aplica: este PR no toca nada de docs/. Los archivos modificados son README.md, LICENSE, CLAUDE.md y un comando
  • La ficha de docs/features/ está en estado Verificada — no aplica: este repositorio es el andamiaje y no tiene fichas propias
  • Hay una entrada en changelog/ con este cambio — en .template/changelog/, que es donde el protocolo manda registrar los cambios sobre el andamiaje
  • La sección "Evidencia" contiene salida real de comandos, no una descripción de lo que pasaría
  • Se ha ejecutado /security-review si hay cambios sensibles — no se ha ejecutado y no lo veo justificado aquí: no hay código nuevo, ni cambios en el workflow, ni en permisos. Lo único con superficie externa son las tres imágenes de img.shields.io de la cabecera, y GitHub las sirve a través de su proxy (camo), así que quien visite el README no expone su IP a un tercero

Efecto secundario que este PR resuelve: rellenar el LICENSE dejaba huérfanas tres instrucciones que pedían "sustituye [YEAR] y [AUTHOR]" — en el checklist de inicialización, en /init-proyecto y en la tabla de adaptación. Las tres se han reescrito para decir lo que corresponde: la plantilla se distribuye con el copyright de su autor y cada proyecto pone el suyo al inicializar. Añadido también un aviso de que los badges apuntan a este repositorio y hay que quitarlos o repuntarlos.

LICENSE llevaba desde el primer commit con [YEAR] y [AUTHOR] sin rellenar. Un
MIT sin titular no concede permisos a nadie con claridad, y este repositorio es
público y está pensado para que se copie.

- LICENSE: Copyright (c) 2026 Pol Marzà. El año sale del primer commit del
  repositorio, del 7 de mayo de 2026
- Los tres sitios que pedían "sustituye [YEAR] y [AUTHOR]" —checklist de
  inicialización, /init-proyecto y la tabla de adaptación— ya no buscan unos
  marcadores que han dejado de existir: ahora dicen que la plantilla se
  distribuye con el copyright de su autor y que cada proyecto pone el suyo
- README: cabecera centrada con cuatro badges (workflow de cobertura, licencia,
  pnpm v11, agnosticismo de stack) y enlace directo a "Usar esta plantilla"
- Diagrama Mermaid del ciclo de feature antes de los diez puntos del protocolo,
  que se leían como un muro
- Nueva sección "Comandos": los seis slash commands estaban enterrados dentro de
  un bullet de "¿Qué hay dentro?"
- Aviso en el checklist de inicialización de que los badges apuntan al
  repositorio de la plantilla y hay que quitarlos o repuntarlos

Los badges son los cuatro que dicen algo cierto y comprobable. Ninguno decorativo
del tipo "PRs welcome" ni métricas de paquetes que este repositorio no publica.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@polmarza
polmarza merged commit 063c8c7 into main Aug 18, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant