github/awesome-copilot
Añadir comentarios educativos al código para convertirlo en material de aprendizaje
Acerca de esta habilidad
Guía al agente para añadir comentarios educativos a un archivo de código elegido por el usuario. Explican decisiones de sintaxis, patrones y diseño, adaptando la profundidad a conocimientos básicos, intermedios o avanzados. Conserva codificación, finales de línea, sangría y validez sintáctica. Busca alcanzar el 125% de la longitud original, con un máximo de 400 líneas nuevas. Si no se especifica archivo, lo solicita y enumera los candidatos.
¿Cómo se utiliza esta habilidad?
1. Indica el archivo adjuntándolo o mediante una variable del chat. Si no lo indicas, el agente lo pide; si hay varios candidatos, ofrece una lista numerada.
2. Puedes ajustar: Comment Detail (1–3, predeterminado 2), Repetitiveness (2), User Knowledge para conocimientos generales de programación (2), Educational Level para el lenguaje concreto (1), Line Number Referencing para etiquetas como Note 1 (yes) y Nest Comments para sangrar dentro de bloques (yes).
3. Ejemplo: /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no. El agente interpreta Line Numer como Line Number Referencing = no.
4. Planifica qué partes explicar y añade comentarios respetando la sintaxis y sangría, sin emojis ni caracteres especiales.
5. Revisa la codificación y la sintaxis del resultado. Si el archivo ya se procesó con esta habilidad, pide mejorar los comentarios existentes en lugar de añadir líneas.
Requisitos y limitaciones
No requiere cuentas ni paquetes externos. Son instrucciones para un agente capaz de leer y editar archivos del espacio de trabajo.
Limitaciones:
- Referencias como #file: y comandos con barra corresponden a entornos concretos; la forma de adjuntar archivos varía.
- Fetch List incluye enlaces opcionales como PEP 263; acceder a ellos requiere web, pero no es imprescindible.
- El objetivo del 125% tiene un límite de 400 líneas nuevas, o unas 300 para archivos de más de 1.000 líneas.
- Modifica directamente el archivo original; revisa los cambios o usa control de versiones antes de aceptarlos.
- No garantiza resultados sin errores; la revisión humana sigue siendo necesaria.
- Licencia: MIT.
Instalación según el agente
Descarga y descomprime el ZIP. Contiene la carpeta add-educational-comments y el archivo SKILL.md con los adjuntos originales y la licencia.
GitHub Copilot
- Crea esta ruta dentro de tu proyecto si no existe:
.github/skills/ - Copia la carpeta completa de la habilidad en esta ruta:
.github/skills/add-educational-comments/SKILL.md - Abre el proyecto en el agente o actualiza la lista y busca add-educational-comments.
- Solicita la tarea del ejemplo y selecciona la habilidad. Concede solo los permisos necesarios.
Claude Code
- Crea esta ruta dentro de tu proyecto si no existe:
.claude/skills/ - Copia la carpeta completa de la habilidad en esta ruta:
.claude/skills/add-educational-comments/SKILL.md - Abre el proyecto en el agente o actualiza la lista y busca add-educational-comments.
- Solicita la tarea del ejemplo y selecciona la habilidad. Concede solo los permisos necesarios.
OpenAI Codex
- Crea esta ruta dentro de tu proyecto si no existe:
.agents/skills/ - Copia la carpeta completa de la habilidad en esta ruta:
.agents/skills/add-educational-comments/SKILL.md - Abre el proyecto en el agente o actualiza la lista y busca add-educational-comments.
- Solicita la tarea del ejemplo y selecciona la habilidad. Concede solo los permisos necesarios.