Agent skill · writing content · github
add-educational-comments
Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.
Why this skill is useful
Adds domain-specific knowledge on educational commenting practices and structured guidance for enhancing code readability for learners.
What it needs
About 4k tokens when loaded. Last updated 2026-08-07. 37,534 stars on the source repository.
What this skill does
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.). …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills github/add-educational-comments