github/awesome-copilot
Add educational comments to code files to create learning resources
About this skill
Guides an agent to add educational comments to a user-selected code file. Comments explain syntax choices, patterns and design decisions, adapting their depth to beginner, intermediate or advanced knowledge. It preserves encoding, line endings, indentation and syntactic validity. The target is 125% of the original file length, capped at 400 new lines. If no file is specified, the agent asks for one and lists matching files by number.
How do you use this skill?
1. Identify the file by attaching it to the conversation or referring to it as a chat variable. If unspecified, the agent asks; if multiple files match, it lists numbered choices.
2. Optionally adjust: Comment Detail (1–3, default 2), Repetitiveness (default 2), User Knowledge for general programming knowledge (default 2), Educational Level for the specific language (default 1), Line Number Referencing for Note 1-style labels (default yes), and Nest Comments for indentation within code blocks (default yes).
3. Example: /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no. The agent interprets the typo Line Numer as Line Number Referencing = no.
4. It plans which sections need explanations, then adds comments respecting language syntax and indentation, without emoji or special characters.
5. Review the resulting encoding and syntax. If the file has already been processed with this skill, request improvements to existing comments rather than more lines.
Requirements and limitations
No accounts or external packages are required. This is textual guidance for an agent able to read and edit workspace files.
Limitations:
- File references such as #file: and slash commands reflect particular chat environments; attachment methods differ by agent.
- Fetch List includes optional reference links, including PEP 263. Access requires web capability but is not essential.
- The 125% length target is capped at 400 new lines, or about 300 lines for files exceeding 1,000 lines.
- The skill edits the original file directly; review changes or use version control before accepting them.
- Error-free output is not guaranteed; human review remains necessary.
- License: MIT.
Installation by agent
Download and extract the ZIP. It contains the folder add-educational-comments and the file SKILL.md with the original attachments and license.
GitHub Copilot
- Create this path inside your project if it does not exist:
.github/skills/ - Copy the entire extracted skill folder to this path:
.github/skills/add-educational-comments/SKILL.md - Open the project in your agent or refresh the skills list and look for add-educational-comments.
- Request the task shown above and select the skill. Grant only necessary permissions.
Claude Code
- Create this path inside your project if it does not exist:
.claude/skills/ - Copy the entire extracted skill folder to this path:
.claude/skills/add-educational-comments/SKILL.md - Open the project in your agent or refresh the skills list and look for add-educational-comments.
- Request the task shown above and select the skill. Grant only necessary permissions.
OpenAI Codex
- Create this path inside your project if it does not exist:
.agents/skills/ - Copy the entire extracted skill folder to this path:
.agents/skills/add-educational-comments/SKILL.md - Open the project in your agent or refresh the skills list and look for add-educational-comments.
- Request the task shown above and select the skill. Grant only necessary permissions.