Skip to content

Add Educational Comments

Adds teaching-focused explanatory comments to a code file without changing how it runs.

Stars
40,703
Licence
MIT
Files
1 file

What it does

When you point the agent at a source code file, it rewrites that file with extra comments that explain what the code does and why, aimed at learners. It follows configurable settings such as how detailed the explanations are, how often it revisits concepts, and whether each note is numbered. It is instructed to keep the file's encoding, line endings, indentation and syntax intact, and to grow the file by roughly 125% with comments only, capped at 400 new lines.

Great for

  • Students or new programmers who want annotated examples of code they are reading
  • Teachers or course writers preparing commented sample code
  • Developers onboarding to an unfamiliar language or framework

Skip it if

  • Production files where you cannot review changes: the skill edits the file in place and adds hundreds of lines, so unreviewed commits could bloat the codebase or introduce mistakes
  • Very large or generated files: the line limits and rules are designed for files of a few hundred to a thousand lines, and comments on generated code add little value

Try asking

  • “Add educational comments to utils/parser.py”
  • “/add-educational-comments #file:sorting.js Comment Detail = 1, Repetitiveness = 1”
  • “Comment this Haskell module for a beginner, with Line Number Referencing = no”
  • “Add beginner-level notes to main.go explaining goroutines and channels”
Step-by-step guide: how to use Add Educational CommentsInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    add-educational-comments.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip add-educational-comments.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip add-educational-comments.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Work on a copy or under version control so you can review and revert the agent's edits
  • Set Comment Detail and Educational Level to match your experience, and use Line Number Referencing = no if you do not want Note numbers
  • Ask the agent to run your tests or compiler afterward, since the skill itself only asks it to check syntax and encoding

What's inside

  • SKILL.md

Redistributed unmodified from github/awesome-copilot under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.