add-educational-comments
Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.
Best for Educational content creatorsWorks with GitHubLow risk
⌘source
- author
@github- language
- Python
★30kstars
3.6kforks
Apr 18, 2026
✦overview.md
Key Features
- ·Adds educational comments to code files
- ·Adapts explanations to beginner, intermediate, and advanced knowledge levels
- ·Maintains original file structure and encoding
- ·Increases file line count by 125% (up to 400 new lines)
- ·Updates existing notes instead of reapplying rules on reprocessed files
- ·Prompts for file selection when none is provided
Use Cases
- →Creating tutorial code examples with embedded explanations
- →Adding learning annotations to legacy code for new team members
- →Documenting complex algorithms or architecture for educational purposes
Best for
- ✓Educational content creators
- ✓Team onboarding documentation
- ✓Code review preparation
Not ideal for
- !Production deployment
- !Minimizing file size
- !Automated documentation generation
FAQs
name
add-educational-comments
description
Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.
Add 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.
$install
1-click copynpx skills add github/awesome-copilot --skill add-educational-commentsSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.