create-readme

por github

Genera archivos README.md completos para proyectos con estructura y formato profesional. Analiza todo el espacio de trabajo del proyecto para crear documentación contextualmente precisa y bien organizada. Sigue patrones probados de README de código abierto con secciones claras para configuración, uso y características clave. Utiliza Markdown con sabor GitHub y sintaxis de admonición para mejorar la legibilidad y jerarquía visual. Equilibra el detalle con la concisión, evitando secciones innecesarias y emojis excesivos, manteniendo...

npx skills add https://github.com/github/awesome-copilot --skill create-readme
Descargar ZIPGitHub
39.4k

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.

Más skills de github

debugging-workflows
github
Guía para depurar flujos de trabajo agentivos de GitHub: análisis de registros, auditoría de ejecuciones y resolución de problemas.
go-codemod
github
Implementa y prueba codemods de Go para el comando gh aw fix.
acreadiness-policy
github
Ayudar al usuario a seleccionar, redactar o aplicar una política de AgentRC. Las políticas personalizan la puntuación de readiness desactivando comprobaciones irrelevantes, anulando impacto/nivel, estableciendo…
ai-ready
github
Haz que cualquier repositorio esté listo para IA: analiza tu base de código y genera AGENTS.md, copilot-instructions.md, flujos de CI, plantillas de issues y más. Extrae de tu revisión de PR…
create-oo-component-documentation
github
Crear documentación completa y estandarizada para componentes orientados a objetos siguiendo las mejores prácticas de la industria y los estándares de documentación arquitectónica.
dependabot
github
Dependabot es la herramienta integrada de gestión de dependencias de GitHub con tres capacidades principales:
doublecheck
github
Tubería de verificación de tres capas para la salida de IA. Extrae afirmaciones verificables, encuentra fuentes de apoyo o contradicción mediante búsqueda web, realiza revisión adversarial…
foundry-agent-sync
github
Crear y sincronizar agentes de IA basados en prompts directamente en Azure AI Foundry a través de la API REST, desde un manifiesto JSON local. A diferencia de las habilidades de andamiaje que solo…