Refactoriza scripts de Python en proyectos para principiantes añadiendo comentarios instructivos y generando un tutorial completo en README.md.
- Estrellas en GitHub
- 41.038
- Archivos
- 1
- Último commit
- 11 nov 2026
- Licencia
- MIT
- Herramientas permitidas
- —
¿Qué hace la skill comment-code-generate-a-tutorial?
comment-code-generate-a-tutorial es una agent skill. Refactoriza scripts de Python en proyectos para principiantes añadiendo comentarios instructivos y generando un tutorial completo en README.md.
Resumen generado a partir del SKILL.md de la skill.
Sobre la skill comment-code-generate-a-tutorial
La función principal de esta herramienta es convertir scripts de Python en bruto en recursos educativos para nuevos desarrolladores. Toma un script existente y aplica las directrices de estilo PEP 8 para asegurar que el código siga las mejores prácticas estándar de Python. Al renombrar variables y funciones poco claras, el SKILL produce una versión más limpia de la lógica original que es más fácil de seguir para los estudiantes.
Un agente debe cargar este SKILL cuando un usuario necesite transformar un único archivo en un paquete de proyecto completo. El proceso consiste en inyectar comentarios instructivos que expliquen el razonamiento detrás de la lógica en lugar de limitarse a la sintaxis. Finalmente, el SKILL genera un archivo README.md que contiene una descripción general del proyecto, instrucciones de configuración, un desglose de cómo funciona el código y fragmentos de ejemplos de uso. Esto convierte un simple script en un módulo de aprendizaje estructurado.
Lo que un agente puede hacer con ella
- 1Convertir scripts en proyectos educativosTransforma un único script de Python en un proyecto pulido y amigable para principiantes con comentarios instructivos y un tutorial.
- 2Crear documentación de proyecto completaGenera un archivo README.md que incluya instrucciones de configuración, desglose de la lógica y ejemplos de uso.
Escrito a partir del SKILL.md de la skill. Cada caso de uso se verifica con una cita del mismo.
Cómo instalar la skill comment-code-generate-a-tutorial
Cada comando copia la carpeta de la skill al directorio de skills del cliente. Reinicia el cliente o inicia una nueva sesión para cargarla.Instalar la skill comment-code-generate-a-tutorial en Claude Code
~/.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorialInstalar la skill comment-code-generate-a-tutorial en Claude Code (project)
.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial .claude/skills/comment-code-generate-a-tutorialInstalar la skill comment-code-generate-a-tutorial en Codex
~/.agents/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.agents/skills/comment-code-generate-a-tutorialInstalar la skill comment-code-generate-a-tutorial en Gemini CLI
~/.gemini/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.gemini/skills/comment-code-generate-a-tutorialInstalar la skill comment-code-generate-a-tutorial en Claude.ai
npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial comment-code-generate-a-tutorial && zip -r comment-code-generate-a-tutorial.zip comment-code-generate-a-tutorial # claude.ai → Customize → Skills → + → Create skill → Upload a skill → comment-code-generate-a-tutorial.zip
Verificaciones automáticas
Ejecutado 14 nov 2026Informe completo →Superó nuestras comprobaciones automáticas. No es una auditoría de seguridad: lee los scripts antes de dejar que un agente los ejecute. Cómo funcionan las verificaciones
- Repositorio de origen vinculado y accesiblegithub/awesome-copilot/skills/comment-code-generate-a-tutorial is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/comment-c ↗Aprobado
- Licencia de código abierto (OSI)MITspdx.org/licenses/MIT.html ↗Aprobado
- Commit o lanzamiento en el último añoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Aprobado
- Sin descargar y ejecutar ni robo de credenciales en los scriptsNo scripts in the skill folderAprobado
- Sin instrucciones ocultas en SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Aprobado
- Las herramientas preaprobadas están acotadasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Aprobado
SKILL.md
Ver en GitHubTransform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
-
Refactor the code
- Apply standard Python best practices
- Ensure code follows the PEP 8 style guide
- Rename unclear variables and functions if needed for clarity
-
Add comments throughout the code
- Use a beginner-friendly, instructional tone
- Explain what each part of the code is doing and why it's important
- Focus on the logic and reasoning, not just syntax
- Avoid redundant or superficial comments
-
Generate a tutorial as a
README.mdfile
Include the following sections:- Project Overview: What the script does and why it's useful
- Setup Instructions: Prerequisites, dependencies, and how to run the script
- How It Works: A breakdown of the code logic based on the comments
- Example Usage: A code snippet showing how to use it
- Sample Output: (Optional) Include if the script returns visible results
- Use clear, readable Markdown formatting
Archivos de esta skill
1Preguntas sobre la skill comment-code-generate-a-tutorial
¿Cómo instalo la skill comment-code-generate-a-tutorial en Claude Code?
Ejecuta npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorial. Claude Code carga las skills desde ~/.claude/skills (todos los proyectos) o .claude/skills (un proyecto) y usa una skill cuando su descripción coincide con la tarea.
¿Qué clientes pueden usar la skill comment-code-generate-a-tutorial?
Cualquier cliente que lea el formato Agent Skills: Claude Code, Codex, Gemini CLI y claude.ai (subir como ZIP). Los scripts de la skill se ejecutan solo donde el cliente permite la ejecución de código.
¿Qué estándares de codificación sigue este SKILL?
El SKILL asegura que el código refactorizado siga la guía de estilo PEP 8 y aplique las mejores prácticas estándar de Python.
¿Qué secciones se incluyen en el tutorial generado?
El README.md generado incluye una descripción general del proyecto, instrucciones de configuración, un desglose de la lógica, ejemplos de uso y una salida de ejemplo opcional.