Communitygithub.com

geekjourneyx/readme-generator

Genera README.md de nivel de portafolio para proyectos de GitHub. Ideal para solicitudes como «escribe mi README», «genera README», «optimiza README», «mejores prácticas de README», «página de inicio del proyecto», «licencia de código abierto», «infografía README», «portada README», «genera imágenes README con Codex Image Gen / gpt-image-2». El resultado incluye una narrativa README contenida, hasta dos activos visuales de alta calidad, imágenes comprimidas, licencia MIT, recomendaciones de Descripción de GitHub y Topics, calificación por estrellas y, opcionalmente, sugerencias de actualización con gh CLI. El enfoque está en ayudar al proyecto a contar su propia historia y determinar la intensidad visual según el tipo de proyecto, evitando plantillas genéricas, acumulación de información y diseño excesivo.

¿Qué es readme-generator?

Este skill para agentes de IA (como Claude Code, Cursor, Codex) está diseñado para generar README.md profesionales y de alto impacto para proyectos de GitHub. Su objetivo principal no es solo rellenar una plantilla, sino contar la historia del proyecto de manera clara, estética y contenida. El skill sigue una metodología basada en primeros principios, priorizando que el README responda en segundos a qué es el proyecto, por qué vale la pena y cómo empezar a usarlo. Evalúa la calidad del README con un sistema de puntuación (mínimo 90/100) y ajusta la cantidad de elementos visuales según el tipo de proyecto (por ejemplo, menos imágenes para librerías/SDKs, más para proyectos de UI/producto). Utiliza preferentemente Codex Image Gen o gpt-image-2 para generar activos visuales (banner y features) con un estilo minimalista y de alta calidad, con un fallback a HTML/CSS a PNG si la generación de imágenes falla. Finalmente, ofrece recomendaciones para la descripción y topics de GitHub, y sugiere comandos gh CLI para actualizar el repositorio si el usuario lo desea. El skill evita el ruido, la decoración excesiva y las secciones innecesarias, centrándose en entregar un README que parezca una pieza de portafolio de un diseñador de primer nivel.

Compatible con✓Claude Code✓Codex CLI~Cursor
npx skills add geekjourneyx/readme-generator

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Vista previa

Del README del skill

License: MIT
readme-generator preview
readme-generator preview

Documentación

Generador de README para GitHub

El README es la primera página de portafolio de un proyecto. No es el índice de un manual, ni un contenedor de listas de funciones. Debe responder tres cosas en muy poco tiempo:

  1. Qué es esto.
  2. Por qué merece la pena verlo.
  3. Cómo empiezo a usarlo.

El objetivo de este Skill es generar un README de nivel 100: claro, estético, contenido, creíble, que permita entender el proyecto como una obra completa.


Principios Fundamentales

El README es una puerta de entrada de confianza y una ruta de acceso, no un documento completo. Debe ayudar a quien abre el repositorio por primera vez a tomar una decisión rápida:

  1. ¿Qué problema resuelve este proyecto?
  2. ¿Es adecuado para mí?
  3. ¿Puedo ejecutarlo, instalarlo o seguir investigando de inmediato?

Los proyectos de código abierto con más de 1w estrellas no suelen ganar por la cantidad de información, sino por una pantalla inicial clara, una ruta de inicio directa, una entrada de documentación fiable e información comunitaria contenida. Las imágenes, insignias, información del autor y principios de diseño son solo ayudas; una vez que ralentizan la comprensión, se convierten en ruido.

La decisión clave de este Skill: el README primero explica el proyecto, luego lo embellece; lo visual sirve a la comprensión, no la sustituye.


Estándar de Calidad

Restringe todas las salidas usando la siguiente tabla de puntuación:

DimensiónPuntuaciónCriterio
Comprensión en 15 segundos25La pantalla inicial debe mostrar el nombre del proyecto, su valor y a quién va dirigido.
Historia del proyecto20No es una lista de funciones, sino que explica el contexto, la motivación y el resultado.
Expresión visual20Las imágenes parecen obras, no pequeñas capturas de pantalla de procesos.
Inicio rápido15La ruta de instalación y uso es corta, clara y se puede copiar.
Credibilidad del producto10Muestra resultados reales, límites de capacidad o ejemplos.
Moderación y reducción de ruido10Elimina repeticiones, lemas, explicaciones excesivas y decoración.

No se entregará ningún README con una puntuación inferior a 90; primero se elimina el ruido, se amplifica lo importante y se reordena la narrativa.

Base de proyectos con muchas estrellas

Por defecto, se aprende de proyectos de código abierto con muchas estrellas en las siguientes estructuras:

  • Nombre del proyecto + propuesta de valor en una frase.
  • Pocas insignias necesarias, sin acumular adornos de estado.
  • Inicio rápido o enlace a documentación al principio.
  • Los ejemplos solo aparecen si reducen el coste de inicio.
  • Contribución, comunidad, seguridad y licencia son claros y concisos.
  • Los proyectos de interfaz de usuario / producto pueden incluir capturas de pantalla; las bibliotecas, SDK e infraestructura, pocas o ninguna imagen.

No conviertas el README en un manifiesto de diseño, un manual completo, un muro de funciones, una tarjeta de presentación social o un informe de flujo de trabajo interno.


Principios de Diseño

Obligatorio

  • H1 debe ser el nombre oficial del proyecto, seguido inmediatamente de una propuesta de valor.
  • El README comienza presentando el valor del proyecto, antes de los detalles de instalación.
  • Las imágenes solo expresan un punto clave, pero deben funcionar como tarjeta de presentación del proyecto: permitir al lector ver de un vistazo el nombre y el posicionamiento.
  • Por defecto, máximo dos imágenes: una portada y una imagen de capacidad o resultado principal.
  • GitHub reduce el tamaño de las imágenes mostradas; el texto principal de la imagen debe diseñarse con un tamaño de fuente similar al de un póster.
  • La descripción de las funciones debe ser específica, pero no exagerada; si se puede explicar con resultados, no te autoelogies.
  • Mantén la información del autor y la licencia concisa, sin acumular tarjetas de presentación social.

Evitar a toda costa

  • Títulos con arte ASCII.
  • Emojis decorativos en títulos o tablas de autores.
  • Grandes párrafos de frases vacías del tipo «somos muy profesionales».
  • Más de 6 tarjetas pequeñas apiladas en una misma imagen.
  • Diagramas de flujo llenos de etapas, comandos y letra pequeña.
  • Usar un tercer diagrama de flujo como elemento por defecto; la forma de trabajar suele explicarse mejor con texto.
  • Usar Image Gen como herramienta de maquetación de texto largo.
  • Convertir el README en un manual de producto completo; la documentación detallada debe ir en docs/.

Flujo General

Fase 0    Lectura del proyecto y reconocimiento de patrones
Fase 1    Refinamiento de la historia del proyecto
Fase 2    Selección del método de generación visual
Fase 3    Generación de activos visuales de nivel de obra
Fase 4    Ensamblaje del README
Fase 5    Sugerencias de meta-información de GitHub
Fase 6    Verificación y entrega

Fase 0: Lectura del proyecto y reconocimiento de patrones

Primero se lee el proyecto, no se escribe directamente una plantilla.

Comprobar:

ls
find . -maxdepth 2 -type f | sed 's#^\./##' | sort | head -80

Leer con prioridad:

  • README.md
  • package.json / pyproject.toml / go.mod / Cargo.toml
  • docs/
  • Archivos de entrada principales
  • Archivos de ejemplo, capturas de pantalla, demostraciones

Determinar el escenario y el presupuesto visual:

EscenarioMétodo de determinaciónEstrategiaLímite de imágenes
Nuevo READMESin README, o README muy cortoGeneración completa, pero manteniendo la ruta corta1-2
Actualizar READMEREADME existente con contenido válidoConservar contenido único, reescribir estructura y pantalla inicial0-2
Mejora de portafolioEl usuario enfatiza estética, historia, presentaciónPriorizar narrativa y expresión de portada2
Modo solo documentaciónSDK, librería, herramienta backend, infraestructuraPocas imágenes, centrarse en instalación, API, entrada de documentación0-1
Exhibición de UI / ProductoTiene interfaz, capturas, demo, resultados visualesUsar resultados reales o portada para ayudar a la comprensión1-2

Al actualizar un README existente, no elimines el contenido clave que el usuario ya tenga. Primero extrae el contenido que se puede conservar y luego reorganiza.

Revisión de reducción de ruido

Antes de escribir el README, marca qué contenido debe moverse fuera o eliminarse:

ContenidoTratamiento por defecto
Tabla de puntuación de diseño, principios de trabajo, metodología internaPoner en SKILL.md o docs/, no en el README
Árbol de archivos generado, variables de plantilla, detalles de scriptConservar solo si el usuario necesita documentación de desarrollo
Tercer diagrama de flujoEliminar, reemplazar con 2-4 líneas de texto o una lista breve
Demasiados enlaces socialesMantener solo los enlaces principales (GitHub / página web, etc.)
Listas de funciones demasiado genéricasCombinar en 3 capacidades orientadas a resultados
Contexto largo antes de la instalaciónAcortar, adelantar el inicio rápido

Fase 1: Refinamiento de la historia del proyecto

Recopilar o inferir 7 campos:

CampoDescripción
project_nameNombre oficial del proyecto
taglinePropuesta de valor en una frase, corta y con criterio
originContexto de aparición del proyecto: por qué se necesita
audienceQuién lo usará
promiseQué resultado obtiene el usuario
proofCapacidad real, capturas de pantalla, salida, ejemplos, métricas
startRuta de inicio más corta

No hagas demasiadas preguntas. Si se puede inferir del proyecto, infiere directamente; solo pregunta al usuario si afecta a la precisión de la narrativa.

Estructura narrativa recomendada

Nombre del proyecto
Propuesta de valor en una frase
Portada visual (decidir según el tipo de proyecto si es necesaria)

Qué es esto
Por qué se necesita
Qué obtendrás
Inicio rápido
Ejemplos o resultados
Cómo funciona (texto, sin imagen por defecto)
Instalación
Licencia
Autor

Si el proyecto es más una herramienta, librería o infraestructura, adelanta «Inicio rápido» después de «Por qué se necesita». El orden del README debe servir a la acción del lector, no a la integridad de la plantilla.


Fase 2: Selección del método de generación visual

Hay dos tipos de imágenes en el README:

  1. Portada de obra: transmite estilo, tema, punto de recuerdo.
  2. Diagrama de estructura: transmite pasos, capacidades, comparaciones, flujos.

Seleccionar el modo según la intención del usuario:

ModoEscenario de aplicaciónEstrategia de imagen
portfolioRecomendado por defecto, adecuado para proyectos que necesitan mostrar una sensación de obra completa1 portada + 1 imagen de capacidad principal
clean-docSDK, librería, herramienta backend, infraestructura seria0-1 imágenes, priorizar inicio rápido y ejemplos
visual-storyHerramientas de IA, herramientas de diseño, productos independientes, exhibición de obrasMáximo 2 imágenes; Codex Image Gen se encarga de los puntos de recuerdo
structuredEl usuario solicita explícitamente infografías, diagramas de comparación, diagramas de flujo1-2 pósters HTML/CSS, garantizando precisión del texto

Por defecto, primero determina el tipo de proyecto; no fuerces el modo portfolio. La prioridad de generación de activos visuales es fija:

  1. Codex Image Gen Skill: Usar preferentemente la capacidad de generación de imágenes integrada de Codex para generar activos visuales.
  2. Ligereza: Las imágenes de exhibición del README deben convertirse primero a WebP, luego escribir la ruta de referencia en el README.
  3. Fallback HTML a PNG: Solo cuando Image Gen no esté disponible, la salida no cumpla con los requisitos, o el usuario solicite explícitamente texto estructurado preciso, se degradará a la captura de pantalla de plantilla HTML/CSS.

No uses la captura de pantalla HTML como ruta por defecto. Es una solución de respaldo fiable, no la opción visual preferida.


Fase 3: Generación de activos visuales de nivel de obra

La salida por defecto utiliza dos nombres de archivo estables:

assets/banner.webp
assets/features.webp

Así, la ruta de referencia del README es estable, independientemente de si las imágenes provienen de Codex Image Gen o del fallback de captura de pantalla HTML.

Responsabilidades de las imágenes

ImagenObjetivoMétodo recomendado
banner.webpTarjeta de presentación del proyecto, establece el nombre, el posicionamiento y el punto de recuerdoCodex Image Gen prioritario
features.webpImagen de difusión de capacidades principales, resultados o procesos necesariosCodex Image Gen prioritario; fallback HTML cuando se necesita precisión textual

No generes workflow.png o workflow.webp por defecto. Si el usuario solicita explícitamente un diagrama de flujo, fusiona el contenido del flujo en features.webp o colócalo en el texto; no añadas una tercera imagen.

Estilo visual por defecto

Todos los activos visuales del README adoptan por defecto el mismo estilo:

Fondo negro, minimalista, iluminación cinematográfica, alto contraste, grandes espacios en blanco, baja luminosidad, tres colores: blanco, gris y dorado cálido, con sensación de portada de revista de alta gama.
Textura de la imagen: fondo negro muy profundo #050505, grano de papel sutil, poca profundidad de campo, niebla volumétrica, luz de contorno fina, toques metálicos selectivos.
Objetivo de calidad: propio de un diseñador de nivel 10k estrellas.

Restricciones de diseño:

  • El fondo debe ser principalmente negro profundo #050505.
  • Los colores se limitan a blanco, gris y dorado cálido; no introduzcas degradados arcoíris, neón azul violeta o colores decorativos de alta saturación.
  • Usa grandes espacios en blanco e iluminación local, no acumules elementos.
  • Las imágenes deben contener poco texto de alto valor, asumiendo la función de difusión y posicionamiento, sin largas explicaciones.
  • Cuanto menos texto, más potente: cada imagen solo conserva la información que el lector debería recordar incluso después de salir del README.
  • No incluyas párrafos, comandos, tablas, acumulaciones de números de versión o descripciones densas.

Estrategia de texto para la tarjeta de presentación

Por defecto, se usa una «imagen tipo tarjeta de presentación del proyecto», no una imagen puramente atmosférica.

ImagenTexto recomendadoLímite
banner.webpNombre del proyecto + posicionamiento en una frase + 1-3 etiquetas cortas18 palabras en inglés o 28 caracteres en chino
features.webp2-3 frases de resultado, opcionalmente con un título cortoCada frase de 2-5 palabras

Un buen texto debe parecerse al título de una portada, no a un manual de instrucciones:

  • El nombre del proyecto debe ser claro, colocado preferentemente en banner.webp.
  • La frase de posicionamiento describe el resultado, no un lema, por ejemplo, «Portfolio-grade README design for open source projects».
  • Las etiquetas solo deben incluir las palabras con mayor valor de búsqueda y memoria, por ejemplo, Story, Visual, Signal.
  • Se puede usar chino, pero con moderación; los nombres de proyecto en inglés y las etiquetas cortas en inglés suelen ser más estables.
  • Si Image Gen escribe mal el texto, reinténtalo una vez; si aún no es preciso, conserva la imagen base de Image Gen y usa el fallback HTML/CSS para el texto preciso.
  • No sacrifiques la precisión del nombre del proyecto y el posicionamiento por un «generado completamente por IA».

Tamaño de fuente mínimo

Al diseñar para 1920×1080:

ElementoTamaño de fuente mínimo
Título principal92px
Título principal en chino80px
Título de tarjeta grande48px
Texto del cuerpo28px
Etiquetas auxiliares22px
Pie de página20px

No uses texto por debajo de 18px. Será ilegible después de la reducción de escala de GitHub.

Los productos de Codex Image Gen solo deben mantener una relación de aspecto 16:9 y suficiente claridad; no fuerces un remuestreo de una buena imagen para que encaje en 1920×1080. Las imágenes de exhibición del README deben guardarse preferentemente como WebP; 1920×1080 es el tamaño de plantilla para el fallback HTML a PNG.

Fallback HTML a PNG

Solo usar cuando Image Gen no esté disponible, el usuario requiera texto estructurado preciso, o la salida de Image Gen no pase la verificación:

node scripts/gen_infographic.mjs /tmp/readme-banner.html assets/banner.png 1920 1080
node scripts/gen_infographic.mjs /tmp/readme-features.html assets/features.png 1920 1080
node scripts/convert_webp_assets.mjs assets/banner.png assets/banner.webp assets/features.png assets/features.webp

Las plantillas provienen de:

templates/banner.html
templates/features.html

Variables de la plantilla:

{{PROJECT_NAME}}
{{TAGLINE}}
{{PRIMARY_COLOR}}
{{CATEGORY}}
{{PLATFORM}}
{{LANGUAGE}}
{{VERSION_INFO}}
{{TECH_CARDS}}
{{FEATURE_CARDS}}
{{FEATURE_COUNT}}

Estructura de las tarjetas:

  • {{TECH_CARDS}} se usa en el lado derecho de la portada, se recomiendan 2-3 ítems, solo etiquetas cortas y una frase de descripción.
  • {{FEATURE_CARDS}} solo incluye 2-3 tarjetas grandes; la primera puede marcarse como featured.
  • Si es necesario expresar un flujo de trabajo, usa las 3 fases de resultado en features.webp para albergarlo; no añadas una tercera imagen.

Método Codex Image Gen / gpt-image-2

Por defecto, se da prioridad a la capacidad de generación de imágenes integrada de Codex; no codifiques scripts de API temporalmente en el proyecto.

Contenido adecuado para Image Gen:

  • Portada del README.
  • Imagen atmosférica del producto.
  • Visual de portafolio.
  • Imagen de concepto abstracto.
  • Extensión de estilo a partir de una imagen existente.

Contenido no adecuado para Image Gen:

  • Diagramas de flujo precisos.
  • Gran cantidad de texto en chino o múltiples párrafos.
  • Comandos, versiones, tablas.
  • Texto largo o imágenes de interfaz de usuario que requieren precisión palabra por palabra.

Estructura de prompt recomendada:

Use case: productivity-visual
Asset type: GitHub README visual asset, 16:9
Project: <project_name>
Story: <origin + promise>
Visual direction: black background, minimalist, cinematic lighting, high contrast, large negative space, low brightness, premium magazine cover
Texture and lighting: #050505 deep black background, subtle paper grain, shallow depth of field, volumetric haze, thin rim light, selective metallic highlights
Palette: white, gray, warm gold only
Composition: one strong visual idea, restrained, spacious, no dense UI
Quality bar: 10k-star designer portfolio quality
Text policy: include only high-value name-card text. Use the exact project name, one short positioning line, and optional 1-3 short labels. No paragraphs, commands, tables, tiny captions, or decorative text.
Avoid: emoji, clutter, fake interface text, tiny labels, generic gradients, bright neon, overdesigned dashboards

Si Image Gen no es compatible, no se puede invocar, o la salida muestra texto erróneo/desviaciones de estilo, reintenta una vez con un prompt de texto más corto; si aún no es preciso, retrocede al flujo de fallback HTML a PNG para manejar el texto preciso.

Ligereza de las imágenes

Las imágenes de exhibición del README usan WebP por defecto. WebP suele ser más adecuado para la carga del README que PNG; PNG solo se usa como producto intermedio del fallback de captura de pantalla HTML, para imágenes transparentes o cuando se necesita compresión sin pérdidas.

Comando por defecto:

npm run webp

Si el proyecto no tiene un script de conversión a WebP, usa preferentemente cwebp, sips o herramientas ligeras disponibles. No introduzcas dependencias pesadas solo para la conversión. Si no se puede convertir, conserva PNG y explica el motivo.

Revisión visual

Después de generar cada imagen, comprueba:

  • Sigue siendo legible después de reducirse al ancho de visualización del README de GitHub.
  • Una imagen solo comunica un punto principal.
  • No hay acumulación de texto pequeño.
  • El nombre del proyecto y la frase de posicionamiento son visibles de un vistazo.
  • No hay errores ortográficos, caracteres extraños o pseudotexto en la imagen.
  • No hay decoración excesiva.
  • El estilo visual es coherente con la historia del proyecto.
  • Las imágenes de Image Gen no tienen texto erróneo o marcas de agua superfluas.
  • Después de la compresión, la imagen sigue siendo nítida, sin bandas de color evidentes, ruido destructivo o bordes de texto borrosos.

Fase 4: Ensamblaje del README

Estructura por defecto:

<div align="center">

# Nombre del proyecto

**Propuesta de valor en una frase**

<img src="assets/banner.webp" alt="[Nombre del proyecto] — [Propuesta de valor]" width="100%">

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

</div>

---

## Qué es esto

[2-3 frases que explican el proyecto, el contexto y el resultado.]

## Por qué se necesita

[Describe el problema real, no una lista de antipatrones.]

## Qué obtendrás

<img src="assets/features.webp" alt="[3 capacidades principales]" width="100%">

## Cómo funciona

[2-4 líneas que explican cómo funciona; no incluyas una tercera imagen por defecto.]

## Inicio rápido

[Ruta ejecutable más corta.]

## Instalación

[Dependencias y comandos de instalación.]

## Licencia

[MIT](./LICENSE)

## Sobre el autor

[Información concisa del autor.]

Reglas:

  • No uses más de 3 insignias, a menos que el proyecto realmente necesite indicadores de estado.
  • No repitas la misma lista de funciones después de las imágenes.
  • No incluyas «Principios de diseño», «Estructura del proyecto», «Contenido generado» en el README; conserva solo la parte útil para el lector.
  • No incluyas una tercera imagen de flujo de trabajo por defecto; dos imágenes son suficientes para transmitir la sensación de obra y la información principal.
  • Si hay explicaciones detalladas, colócalas en docs/; el README solo actúa como entrada.

Fase 5: Recomendaciones de metainformación de GitHub

La Descripción del Repositorio y los Topics son la puerta de entrada para la búsqueda de GitHub, la asociación de Trending, las referencias de búsqueda de IA y el juicio rápido humano. No son contenido del README, no los escribas en README.md; solo ofrécelos como sugerencias independientes en la respuesta final.

Objetivos de primeros principios

  • Descripción responde: ¿Para quién crea qué resultado este proyecto?
  • Topics responde: ¿En qué cubos de búsqueda debería clasificarse este proyecto?
  • Cantidad recomendada determinada por la calidad de la señal, no se busca cantidad; 7-9 de alta calidad suelen ser mejores que 20.
  • Equilibrio Trending / SEO / GEO: Debe cubrir términos de búsqueda populares, pero también mantener la precisión del proyecto para facilitar las referencias de IA.

Reglas de generación de Descripción

Genera 3 candidatos y puntúa cada uno:

[Verbo] [resultado específico] para [audiencia] — [2-3 palabras clave precisas]

Restricciones estrictas:

  • Priorizar inglés, ≤ 160 caracteres.
  • Comenzar con verbo: Design / Generate / Build / Create / Convert / Automate.
  • Incluir las 2-3 palabras clave más centrales del proyecto.
  • Sin emojis, signos de exclamación o adjetivos de marketing.
  • No escribir capacidades que no se puedan respaldar con hechos del proyecto.

Puntuación:

DimensiónPuntuaciónCriterio
Precisión40¿Es fiel a la capacidad real del proyecto?
Valor de búsqueda25¿Cubre términos de búsqueda comunes en GitHub / Google?
Citabilidad por IA20¿Puede ser entendida directamente por ChatGPT / Claude / Perplexity?
Moderación15¿Carece de exageración y palabrería?

Clasificación por estrellas:

PuntuaciónEstrellas
90-1005 estrellas, se recomienda su uso
80-894 estrellas, usable pero mejorable
70-793 estrellas, solo apta como alternativa
< 70No recomendada

Reglas de generación de Topics

Primero, establece un grupo de candidatos, luego filtra las recomendaciones finales.

Fuentes de candidatos:

  • Tipo de proyecto: agent-skill, cli-tool, developer-tools, documentation
  • Tecnología central: nodejs, playwright, codex, image-generation
  • Ámbito de aplicación: readme, github-readme, open-source, portfolio
  • Tendencias actuales: AI agent, image generation, developer tooling, documentation automation
  • Palabras clave que aparecen en los archivos reales del proyecto y en la narrativa del README

Reglas de filtrado:

  • Recomendar de 7 a 9, no más de 10, a menos que el proyecto abarque múltiples áreas claras.
  • Los topics deben estar en minúsculas, usando solo letras, números y guiones.
  • Eliminar palabras demasiado genéricas: software, tool, app, github, project, ai.
  • Eliminar palabras duplicadas: readme y github-readme pueden coexistir; open-source y opensource solo conserva uno.
  • No añadir topics falsos para seguir tendencias.

Cada topic recibe una calificación de estrellas y una razón:

EstrellasSignificado
5 estrellasAltamente relevante, alto valor de búsqueda, debe incluirse
4 estrellasRelevante y con valor de descubrimiento, puede incluirse
3 estrellasCierta relación, pero no es central
2 estrellasRelación débil, generalmente no recomendado
1 estrellaRuido, no incluir

Formato de salida:

Recomendaciones de Descripción de GitHub:

1. ★★★★★ <descripción>
   Razón: ...

2. ★★★★☆ <descripción>
   Razón: ...

Recomendación final: <descripción>

Recomendaciones de Topics de GitHub:

Incluir:
- ★★★★★ github-readme — Describe con precisión el propósito del proyecto
- ★★★★★ agent-skill — Coincide con la forma del proyecto
- ★★★★☆ image-generation — Incluir cuando el proyecto soporte Image Gen

No incluir:
- ★★☆☆☆ ai — Demasiado genérico, ruido de búsqueda
- ★★☆☆☆ github — Demasiado genérico, no ayuda a la clasificación

Actualización opcional con gh CLI

Si el usuario tiene gh instalado, el directorio actual ya es un repositorio Git y se puede analizar el remote de GitHub, se puede sugerir al usuario que el Agente use gh repo edit para actualizar. No actualices sin permiso; primero debes mostrar el contenido que se va a ejecutar y esperar la confirmación del usuario.

Comprobar:

gh --version
git remote -v

Formato de comando sugerido:

gh repo edit OWNER/REPO \
  --description "<final-description>" \
  --add-topic topic-one \
  --add-topic topic-two \
  --add-topic topic-three

Si es necesario reemplazar topics antiguos, primero lee los topics actuales y luego elimina solo los elementos explícitamente no recomendados:

gh repo view OWNER/REPO --json description,repositoryTopics
gh repo edit OWNER/REPO --remove-topic old-topic --add-topic new-topic

Nota: git no puede actualizar la metainformación del repositorio

El comando git no puede modificar la Descripción o los Topics de un repositorio de GitHub. Motivo: La Descripción y los Topics son metainformación de la plataforma GitHub, no configuraciones de commit, branch, tag o remote dentro del repositorio Git.

git remote -v solo se puede usar para identificar OWNER/REPO, no para actualizar la metainformación.

Si no tienes gh, solo proporciona los valores recomendados y pide al usuario que actualice manualmente en la página de GitHub; no proporciones comandos alternativos complejos.

No uses el archivo README para almacenar estas recomendaciones; pertenecen a las sugerencias de acción para el usuario en el momento de la entrega.


Fase 6: Verificación y entrega

Antes de la entrega, debes verificar:

node --version
npm run showcase
file assets/banner.webp assets/features.webp
git status --short

Si se modificaron las plantillas o las imágenes reales, debes regenerar los WebP y abrirlos para inspeccionarlos.

El informe final solo debe decir:

  • Qué se cambió.
  • Cuál es el resultado.
  • Qué verificaciones se realizaron.
  • Si hay algún punto que el usuario deba decidir.

No escribas detalles de implementación y procesos largos para el usuario.

Skills relacionados