PlugWiki

Add Educational Comments Skill for Claude Code: Teach in Your Code

Adds teaching-style comments to a code file so it works as a learning resource. Listed in github/awesome-copilot.

Installs
9.2K
on skills.sh
Stars
40.7K
on GitHub
Updated
Oct 2026
last repo commit

add-educational-comments makes your agent act as a teacher and write explanatory comments into a file you name. It asks for a file if you give none and offers a numbered list of close matches. It then adds comments until the file is about 125% of its original length, up to 400 new lines.

It edits the file in place and bundles no scripts. You can tune it with nine settings, such as comment detail, how often ideas repeat and how much you already know. A file that was processed before gets its comments revised instead of padded again.

Good for

  • Learners who want a file explained line by line in its own comments
  • Teachers and mentors preparing example code for students
  • Developers onboarding to an unfamiliar language or framework

Install add-educational-comments

Claude Code

  1. 1

    Copy this prompt.

    Install the add-educational-comments skill in Claude Code. Run this command:
    
    npx skills add https://github.com/github/awesome-copilot --skill add-educational-comments
    
    Then check that it loaded and tell me how to use it.
  2. 2

    Paste it into Claude Code. It shows the change and asks before running it.

Requires Node.js.

From its listing on skills.sh. Source.

What's in the skill

When it loads

Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

Sections in SKILL.md

  1. Role
  2. Objectives
  3. Line Count Guidance
  4. Educational Commenting Rules
  5. Encoding and Formatting
  6. Content Expectations
  7. Safety and Compliance
  8. Workflow
  9. Configuration Reference
  10. Properties
  11. Parameters
  12. Default Configuration
  13. Examples
  14. Missing File
  15. Custom Configuration
  16. Final Checklist

Key facts

Installs on skills.sh
9,247 (Nov 2, 2026)
Last repo commit
Oct 30, 2026
Files in the folder
1 file: SKILL.md

What it includes

  • Asks which file to comment and offers a numbered list of close matches

    With no file given, the skill replies "Please provide a file or files to add educational comments to." and lets you pick by number or name.

    Try: “/add-educational-comments”

    Read · Ask for a file

  • Writes comments into your file that explain the why behind syntax and design choices

    Comments cover the lines that best show language or platform ideas. They keep the file's encoding, line endings and indentation.

    Try: “/add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no”

    Write · Add educational comments

  • Adds about 125% of the original length, never more than 400 new lines

    Files over 1,000 lines aim for no more than 300 new comment lines. Files processed before get revised comments instead.

    Line budget

  • Nine settings tune depth, repetition, domain, your levels, note numbers, nesting and links

    File Name, Comment Detail, Repetitiveness, Educational Nature, User Knowledge, Educational Level, Line Number Referencing, Nest Comments and Fetch List. Missing ones use defaults.

    Settings

  • Checks formatting, encoding and syntax are intact and the line limits are met

    The final checklist also asks for suggestions only when they help learning.

    Validate

From the official docs

Permissions

Low risk

The skill edits the file you give it, so a bad edit could damage your code. Commit the file first and review the changes.

What it can do

  • Read your data
  • Create and change things
  • Delete things
  • Read-only mode

Watch out for

  • It rewrites your file in place

    SKILL.md says to keep encoding, line endings and indentation, but a comment can still break indentation-sensitive languages. Commit first and read the diff. github.com

  • Default settings list a reference URL to fetch

    The default Fetch List holds https://peps.python.org/pep-0263/. Remove it if you do not want the agent to fetch it. github.com

  • Community content, not reviewed by GitHub for you

    The awesome-copilot README says the customizations are sourced from third-party developers and asks you to inspect them before installing. Read the SKILL.md first. github.com

Technical details
Scopes
  • Edits the file you name, in place, by inserting comment lines

Questions

What does the add-educational-comments skill do?

It adds explanatory comments to a code file so a learner can read it like a lesson. It explains why the code is written that way, and it keeps the file's structure and encoding.

How do I install it?

Use the install box above. It is a single SKILL.md, so the skills CLI route or a folder copy both work.

How many comments does it add?

About 125% of the original length, capped at 400 new lines. SKILL.md words this two ways ("Increase the total line count by 125%" and "add lines so the file reaches 125% of its original length"), so check the first result.

Does it change my code?

It edits the file you give it, and it is told to keep imports, namespaces and encoding headers working. Commit your file first so you can review or undo the diff.

Do I need an API key?

SKILL.md lists none. The default settings include a link to PEP 263 as a reference the agent may fetch.

Is it safe?

It rewrites the file you point it at and bundles no scripts. The risk is a bad edit, such as a comment that breaks indentation-sensitive code. Use version control and review the diff.

Does it work in Claude Code or the Claude app?

The file is a standard SKILL.md, and the install box shows how to place it in Claude Code or upload it to Claude. The awesome-copilot README targets GitHub Copilot, and nothing in the repo says this skill was tested in Claude.

Information

updated Nov 2, 2026

Folder
skills/add-educational-comments

github/awesome-copilotskills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 2
  1. add-educational-comments SKILL.md · github.com
  2. github/awesome-copilot README · github.com

Updated Nov 2, 2026.