Transforms code files into learning resources by adding context-aware educational comments tailored to specific knowledge levels.
- GitHub stars
- 41,038
- Files
- 1
- Last commit
- Nov 11, 2026
- License
- MIT
- Allowed tools
- —
What does the add-educational-comments skill do?
add-educational-comments transforms code files into learning resources by adding context-aware educational comments tailored to specific knowledge levels.
Summary generated from the skill's SKILL.md.
About the add-educational-comments skill
Turning source code into interactive learning materials is the primary function of this skill. It is designed for developers and students who want to transform existing files into educational resources by injecting context-aware explanations directly into the code. An agent should load this tool when a user provides a file and requests deeper insight into the syntax, design choices, or architectural patterns present in that file.
The process involves analyzing the code and adding comments that explain the reasoning behind specific idioms or language internals. The tool aims to increase the file length by 125% through these notes, though it respects a hard limit of 400 new lines to prevent excessive bloat. It supports various programming languages including Python, Haskell, F#, Nim, Cobra, YAML, and Makefiles.
Users can customize the experience through specific parameters such as Comment Detail, Repetitiveness, and User Knowledge levels on a scale of 1 to 3. The skill also offers Line Number Referencing to connect related explanations and can nest comments within code blocks to maintain proper indentation and readability.
What an agent can do with it
- 1Onboard junior developersTransform a complex codebase into a guided tutorial by adding foundational explanations for beginners.
- 2Deepen language expertiseAdd technical context regarding performance and architecture for advanced practitioners.
- 3Standardize technical documentationApply consistent educational notes to files while maintaining original encoding and indentation styles.
- 4Create structured study guidesGenerate a numbered sequence of notes to link related programming concepts throughout a file.
Written from the skill's SKILL.md. Every use case is checked against a quote from it.
How to install the add-educational-comments skill
Each command copies the skill folder into the client's skills directory. Restart the client or start a new session to load it.Install the add-educational-comments skill in Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsInstall the add-educational-comments skill in Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsInstall the add-educational-comments skill in Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsInstall the add-educational-comments skill in Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsInstall the add-educational-comments skill in Claude.ai
npx degit github/awesome-copilot/skills/add-educational-comments add-educational-comments && zip -r add-educational-comments.zip add-educational-comments # claude.ai → Customize → Skills → + → Create skill → Upload a skill → add-educational-comments.zip
Automated checks
Ran Nov 15, 2026Full report →Passed our automated checks. That is not a security audit: read the scripts before you let an agent run them. How checks work · What to fix for more points
- Source repository linked and reachablegithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Pass
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Pass
- No download-and-run or credential theft in scriptsNo scripts in the skill folderPass
- No hidden instructions in SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Pass
- Pre-approved tools are scopedNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Pass
- SKILL.md follows the Agent Skills formatthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Finding
SKILL.md
View on GitHubAdd Educational Comments
Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.
Role
You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.
- Provide foundational explanations for beginners
- Add practical insights and best practices for intermediate users
- Offer deeper context (performance, architecture, language internals) for advanced users
- Suggest improvements only when they meaningfully support understanding
- Always obey the Educational Commenting Rules
Objectives
- Transform the provided file by adding educational comments aligned with the configuration.
- Maintain the file's structure, encoding, and build correctness.
- Increase the total line count by 125% using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
Line Count Guidance
- Default: add lines so the file reaches 125% of its original length.
- Hard limit: never add more than 400 educational comment lines.
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.
Educational Commenting Rules
Encoding and Formatting
- Determine the file's encoding before editing and keep it unchanged.
- Use only characters available on a standard QWERTY keyboard.
- Do not insert emojis or other special symbols.
- Preserve the original end-of-line style (LF or CRLF).
- Keep single-line comments on a single line.
- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.).
- When instructed with
Line Number Referencing = yes, prefix each new comment withNote <number>(e.g.,Note 1).
Content Expectations
- Focus on lines and blocks that best illustrate language or platform concepts.
- Explain the "why" behind syntax, idioms, and design choices.
- Reinforce previous concepts only when it improves comprehension (
Repetitiveness). - Highlight potential improvements gently and only when they serve an educational purpose.
- If
Line Number Referencing = yes, use note numbers to connect related explanations.
Safety and Compliance
- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution.
- Avoid introducing syntax errors (for example, Python encoding errors per PEP 263).
- Input data as if typed on the user's keyboard.
Workflow
- Confirm Inputs – Ensure at least one target file is provided. If missing, respond with:
Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. - Identify File(s) – If multiple matches exist, present an ordered list so the user can choose by number or name.
- Review Configuration – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g.,
Line Numer) using context. - Plan Comments – Decide which sections of the code best support the configured learning goals.
- Add Comments – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
- Validate – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
Configuration Reference
Properties
- Numeric Scale:
1-3 - Numeric Sequence:
ordered(higher numbers represent higher knowledge or intensity)
Parameters
- File Name (required): Target file(s) for commenting.
- Comment Detail (
1-3): Depth of each explanation (default2). - Repetitiveness (
1-3): Frequency of revisiting similar concepts (default2). - Educational Nature: Domain focus (default
Computer Science). - User Knowledge (
1-3): General CS/SE familiarity (default2). - Educational Level (
1-3): Familiarity with the specific language or framework (default1). - Line Number Referencing (
yes/no): Prepend comments with note numbers whenyes(defaultyes). - Nest Comments (
yes/no): Whether to indent comments inside code blocks (defaultyes). - Fetch List: Optional URLs for authoritative references.
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your Educational Role to interpret them sensibly and still achieve the objective.
Default Configuration
- File Name
- Comment Detail = 2
- Repetitiveness = 2
- Educational Nature = Computer Science
- User Knowledge = 2
- Educational Level = 1
- Line Number Referencing = yes
- Nest Comments = yes
- Fetch List:
Examples
Missing File
[user]
> /add-educational-comments
[agent]
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
Custom Configuration
[user]
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
Interpret Line Numer = no as Line Number Referencing = no and adjust behavior accordingly while maintaining all rules above.
Final Checklist
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
- Keep encoding, end-of-line style, and indentation unchanged.
- Confirm all educational comments follow the configuration and the Educational Commenting Rules.
- Provide clarifying suggestions only when they aid learning.
- When a file has been processed before, refine existing comments instead of expanding line count.
Files in this skill
1add-educational-comments skill questions
How do I install the add-educational-comments skill in Claude Code?
Run npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. Claude Code loads skills from ~/.claude/skills (all projects) or .claude/skills (one project) and uses a skill when its description matches the task.
Which clients can use the add-educational-comments skill?
Any client that reads the Agent Skills format: Claude Code, Codex, Gemini CLI and claude.ai (upload as a ZIP). Scripts in the skill run only where the client allows code execution.
How much content will be added to my file?
The tool aims to increase the total line count by 125% using educational comments, with a hard limit of 400 new lines.
Will the tool change my code's functionality or formatting?
No, the tool is designed to maintain the file's structure, encoding, indentation, and build correctness.
What happens if I don't provide a file name?
The agent will prompt you to provide a file or files, offering a numbered list of close matches if multiple files are found.