PaperclipOrg
Claude Agent Skill · by Github

Add Educational Comments

Takes any code file and transforms it into a teaching resource by adding educational comments that explain syntax, design choices, and language concepts. Automa

Install
Terminal · npx
$npx skills add https://github.com/github/awesome-copilot --skill add-educational-comments
Works with Paperclip

How Add Educational Comments fits into a Paperclip company.

Add Educational Comments drops into any Paperclip agent that handles this kind of work. Assign it to a specialist inside a pre-configured PaperclipOrg company and the skill becomes available on every heartbeat — no prompt engineering, no tool wiring.

S
SaaS FactoryPaired

Pre-configured AI company — 18 agents, 18 skills, one-time purchase.

$27$59
Explore pack
Source file
SKILL.md128 lines
Expand
---name: add-educational-commentsdescription: '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 1. Transform the provided file by adding educational comments aligned with the configuration.2. Maintain the file's structure, encoding, and build correctness.3. 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 with `Note <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](https://peps.python.org/pep-0263/)).- Input data as if typed on the user's keyboard. ## Workflow