# add-educational-comments

> Claude/Codex skill by [@github](https://omgskills.com/library/github/index.md) · 37k stars · Updated 2026-08-01

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

Tags: agent-skills, agents, ai, awesome, custom-agents, github-copilot, hacktoberfest, prompt-engineering

## Install

```sh
git clone https://github.com/github/awesome-copilot /tmp/awesome-copilot && ln -s /tmp/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments
```

## From README

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 Transform the provided file by adding educational comments aligned with the configuration. Maintain the file's structure, encoding, and build correctness.

## Links

- HTML page: https://omgskills.com/skills/github/awesome-copilot/add-educational-comments/
- GitHub: https://github.com/github/awesome-copilot
- Author: [@github](https://omgskills.com/library/github/index.md)

## More from this repo

- [acquire-codebase-knowledge](https://omgskills.com/skills/github/awesome-copilot/acquire-codebase-knowledge/index.md) — Used when the user explicitly asks to map, document, or onboard into an existing codebase.
   - [@github](https://omgskills.com/library/github/index.md) · 39k stars
- [acreadiness-assess](https://omgskills.com/skills/github/awesome-copilot/acreadiness-assess/index.md) — Used to run the AgentRC readiness assessment on the current repository and produce a static HTML dashboard at...
   - [@github](https://omgskills.com/library/github/index.md) · 37k stars
- [acreadiness-generate-instructions](https://omgskills.com/skills/github/awesome-copilot/acreadiness-generate-instructions/index.md) — Used to generate tailored AI agent instruction files via AgentRC instructions command.
   - [@github](https://omgskills.com/library/github/index.md) · 37k stars
