Verwandelt Code-Dateien in Lernressourcen, indem kontextsensitive, pädagogische Kommentare hinzugefügt werden, die auf spezifische Wissensstufen zugeschnitten sind.
- GitHub Stars
- 41.038
- Dateien
- 1
- Letzter Commit
- 11. Nov. 2026
- Lizenz
- MIT
- Erlaubte Tools
- —
Was macht der add-educational-comments Skill?
Verwandelt Code-Dateien in Lernressourcen, indem kontextsensitive, pädagogische Kommentare hinzugefügt werden, die auf spezifische Wissensstufen zugeschnitten sind.
Zusammenfassung erzeugt aus der SKILL.md des Skills.
Über den add-educational-comments skill
Die Hauptfunktion dieses Skills besteht darin, Quellcode in interaktive Lernmaterialien zu verwandeln. Er wurde für Entwickler und Studierende entwickelt, die bestehende Dateien in Bildungsressourcen umwandeln möchten, indem sie kontextsensitive Erklärungen direkt in den Code einfügen. Ein Agent sollte dieses Tool laden, wenn ein User eine Datei bereitstellt und tiefere Einblicke in die Syntax, Design-Entscheidungen oder Architekturmuster in dieser Datei anfordert.
Der Prozess umfasst die Analyse des Codes und das Hinzufügen von Kommentaren, die die Logik hinter spezifischen Idiomen oder Sprach-Internals erklären. Das Tool zielt darauf ab, die Dateilänge durch diese Notizen um 125 % zu erhöhen, hält sich jedoch an ein hartes Limit von 400 neuen Zeilen, um übermäßigen Bloat zu vermeiden. Es unterstützt verschiedene Programmiersprachen wie Python, Haskell, F#, Nim, Cobra, YAML und Makefiles.
User können das Erlebnis über spezifische Parameter wie Comment Detail, Repetitiveness und User Knowledge levels auf einer Skala von 1 bis 3 anpassen. Der Skill bietet zudem Line Number Referencing, um zusammenhängende Erklärungen zu verknüpfen, und kann Kommentare innerhalb von Code-Blöcken verschachteln, um die korrekte Einrückung und Lesbarkeit zu gewährleisten.
Was ein agent damit machen kann
- 1Onboarding von Junior-EntwicklernVerwandle eine komplexe Codebase in ein geführtes Tutorial, indem du grundlegende Erklärungen für Anfänger hinzufügst.
- 2Vertiefung der SprachkenntnisseFüge technischen Kontext zu Performance und Architektur für fortgeschrittene Anwender hinzu.
- 3Standardisierung der technischen DokumentationWende konsistente Lernnotizen auf Dateien an, während die ursprüngliche Kodierung und die Einrückungsstile beibehalten werden.
- 4Erstellung strukturierter LernleitfädenGeneriere eine nummerierte Sequenz von Notizen, um verwandte Programmierkonzepte innerhalb einer Datei miteinander zu verknüpfen.
Geschrieben basierend auf dem SKILL.md des skills. Jeder use case wurde gegen ein zitat daraus geprüft.
So installierst du den add-educational-comments Skill
Jeder Befehl kopiert den Skill-Ordner in das Skills-Verzeichnis des Clients. Starte den Client neu oder beginne eine neue Session, um ihn zu laden.Den add-educational-comments Skill in Claude Code installieren
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsDen add-educational-comments Skill in Claude Code (project) installieren
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsDen add-educational-comments Skill in Codex installieren
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsDen add-educational-comments Skill in Gemini CLI installieren
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsDen add-educational-comments Skill in Claude.ai installieren
npx degit github/awesome-copilot/skills/add-educational-comments add-educational-comments && zip -r add-educational-comments.zip add-educational-comments # claude.ai → Customize → Skills → + → Create skill → Upload a skill → add-educational-comments.zip
Automatisierte Checks
Geluften am 15. Nov. 2026Vollständiger Bericht →Hat unsere automatischen Prüfungen bestanden. Das ist kein Sicherheitsaudit: Lesen Sie die Skripte, bevor ein Agent sie ausführt. Wie die Checks funktionieren · Was du für mehr Punkte verbessern kannst
- Source Repository verknüpft und erreichbargithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Bestanden
- Open Source Lizenz (OSI)MITspdx.org/licenses/MIT.html ↗Bestanden
- Commit oder Release im letzten JahrLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Bestanden
- Keine Download-und-Ausführen-Muster oder Zugangsdatendiebstahl in SkriptenNo scripts in the skill folderBestanden
- Keine versteckten Anweisungen in SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Bestanden
- Vorab erlaubte Tools sind eingeschränktNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Bestanden
- SKILL.md folgt dem Agent-Skills-Formatthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Befund
SKILL.md
Auf GitHub ansehenAdd 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.
- 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 withNote <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).
- Input data as if typed on the user's keyboard.
Workflow
- Confirm Inputs – Ensure at least one target file is provided. If missing, respond with:
Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. - Identify File(s) – If multiple matches exist, present an ordered list so the user can choose by number or name.
- Review Configuration – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g.,
Line Numer) using context. - Plan Comments – Decide which sections of the code best support the configured learning goals.
- Add Comments – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
- Validate – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
Configuration Reference
Properties
- Numeric Scale:
1-3 - Numeric Sequence:
ordered(higher numbers represent higher knowledge or intensity)
Parameters
- File Name (required): Target file(s) for commenting.
- Comment Detail (
1-3): Depth of each explanation (default2). - Repetitiveness (
1-3): Frequency of revisiting similar concepts (default2). - Educational Nature: Domain focus (default
Computer Science). - User Knowledge (
1-3): General CS/SE familiarity (default2). - Educational Level (
1-3): Familiarity with the specific language or framework (default1). - Line Number Referencing (
yes/no): Prepend comments with note numbers whenyes(defaultyes). - Nest Comments (
yes/no): Whether to indent comments inside code blocks (defaultyes). - Fetch List: Optional URLs for authoritative references.
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your Educational Role to interpret them sensibly and still achieve the objective.
Default Configuration
- File Name
- Comment Detail = 2
- Repetitiveness = 2
- Educational Nature = Computer Science
- User Knowledge = 2
- Educational Level = 1
- Line Number Referencing = yes
- Nest Comments = yes
- Fetch List:
Examples
Missing File
[user]
> /add-educational-comments
[agent]
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
Custom Configuration
[user]
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
Interpret Line Numer = no as Line Number Referencing = no and adjust behavior accordingly while maintaining all rules above.
Final Checklist
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
- Keep encoding, end-of-line style, and indentation unchanged.
- Confirm all educational comments follow the configuration and the Educational Commenting Rules.
- Provide clarifying suggestions only when they aid learning.
- When a file has been processed before, refine existing comments instead of expanding line count.
Dateien in diesem Skill
1add-educational-comments Skill-Fragen
Wie installiere ich den add-educational-comments Skill in Claude Code?
Führe npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments aus. Claude Code lädt Skills aus ~/.claude/skills (alle Projekte) oder .claude/skills (ein Projekt) und nutzt einen Skill, wenn seine Beschreibung zur Aufgabe passt.
Welche Clients können den add-educational-comments Skill nutzen?
Jeder Client, der das Agent Skills-Format liest: Claude Code, Codex, Gemini CLI und claude.ai (als ZIP hochladen). Skripte im Skill laufen nur dort, wo der Client Codeausführung erlaubt.
Wie viel Inhalt wird zu meiner Datei hinzugefügt?
Das Tool zielt darauf ab, die Gesamtzahl der Zeilen durch Lernkommentare um 125 % zu erhöhen, wobei ein Limit von maximal 400 neuen Zeilen besteht.
Wird das Tool die Funktionalität oder Formatierung meines Codes ändern?
Nein, das Tool ist darauf ausgelegt, die Struktur, Kodierung, Einrückung und Build-Korrektheit der Datei beizubehalten.
Was passiert, wenn ich keinen Dateinamen angebe?
Der Agent wird dich auffordern, eine oder mehrere Dateien anzugeben, und bietet eine nummerierte Liste mit ähnlichen Treffern an, falls mehrere Dateien gefunden werden.