Transforme des fichiers de code en ressources d'apprentissage en ajoutant des commentaires pédagogiques contextuels adaptés à des niveaux de connaissance spécifiques.
- Étoiles GitHub
- 41 038
- Fichiers
- 1
- Dernier commit
- 11 nov. 2026
- Licence
- MIT
- Outils autorisés
- —
Que fait la skill add-educational-comments ?
Transforme des fichiers de code en ressources d'apprentissage en ajoutant des commentaires pédagogiques contextuels adaptés à des niveaux de connaissance spécifiques.
Résumé généré à partir du SKILL.md de la skill.
À propos du skill add-educational-comments
La fonction principale de cette SKILL est de transformer du code source en supports d'apprentissage interactifs. Elle est conçue pour les développeurs et les étudiants qui souhaitent convertir des fichiers existants en ressources pédagogiques en injectant des explications contextuelles directement dans le code. Un agent doit charger cet outil lorsqu'un utilisateur fournit un fichier et demande une analyse approfondie de la syntaxe, des choix de conception ou des modèles architecturaux présents dans ce fichier.
Le processus consiste à analyser le code et à ajouter des commentaires expliquant le raisonnement derrière des idiomes spécifiques ou le fonctionnement interne du langage. L'outil vise à augmenter la longueur du fichier de 125 % via ces notes, tout en respectant une limite stricte de 400 nouvelles lignes pour éviter un encombrement excessif. Il prend en charge divers langages de programmation, notamment Python, Haskell, F#, Nim, Cobra, YAML et les Makefiles.
Les utilisateurs peuvent personnaliser l'expérience via des paramètres spécifiques tels que le niveau de détail des commentaires (Comment Detail), la répétitivité (Repetitiveness) et le niveau de connaissance de l'utilisateur (User Knowledge) sur une échelle de 1 à 3. La SKILL propose également le référencement par numéro de ligne (Line Number Referencing) pour relier les explications entre elles et peut imbriquer les commentaires dans les blocs de code afin de maintenir une indentation et une lisibilité optimales.
Ce qu'un agent peut faire avec
- 1Onboarder des développeurs juniorsTransformez une base de code complexe en un tutoriel guidé en ajoutant des explications fondamentales pour les débutants.
- 2Approfondir l'expertise linguistiqueAjoutez un contexte technique concernant la performance et l'architecture pour les praticiens avancés.
- 3Standardiser la documentation techniqueAppliquez des notes pédagogiques cohérentes aux fichiers tout en conservant l'encodage et les styles d'indentation d'origine.
- 4Créer des guides d'étude structurésGénérez une séquence numérotée de notes pour lier des concepts de programmation connexes tout au long d'un fichier.
Rédigé à partir du SKILL.md du skill. Chaque cas d'utilisation est vérifié par rapport à une citation de celui-ci.
Comment installer la skill add-educational-comments
Chaque commande copie le dossier de la skill dans le répertoire des skills du client. Redémarrez le client ou démarrez une nouvelle session pour la charger.Installer la skill add-educational-comments dans Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsInstaller la skill add-educational-comments dans Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsInstaller la skill add-educational-comments dans Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsInstaller la skill add-educational-comments dans Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsInstaller la skill add-educational-comments dans Claude.ai
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
Vérifications automatisées
Exécuté le 15 nov. 2026Rapport complet →A réussi nos vérifications automatiques. Ce n'est pas un audit de sécurité : lisez les scripts avant de laisser un agent les exécuter. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessiblegithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Réussi
- Licence open source (OSI)MITspdx.org/licenses/MIT.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Réussi
- Aucun téléchargement-exécution ni vol d'identifiants dans les scriptsNo scripts in the skill folderRéussi
- Aucune instruction cachée dans SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Réussi
- Les outils préautorisés sont limitésNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Réussi
- SKILL.md respecte le format Agent Skillsthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Faille
SKILL.md
Voir sur GitHubAdd 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.
Fichiers de cette skill
1Questions sur la skill add-educational-comments
Comment installer la skill add-educational-comments dans Claude Code ?
Exécutez npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. Claude Code charge les skills depuis ~/.claude/skills (tous les projets) ou .claude/skills (un seul projet) et utilise une skill lorsque sa description correspond à la tâche.
Quels clients peuvent utiliser la skill add-educational-comments ?
Tout client qui lit le format Agent Skills : Claude Code, Codex, Gemini CLI et claude.ai (envoi sous forme de ZIP). Les scripts de la skill ne s'exécutent que si le client autorise l'exécution de code.
Quelle quantité de contenu sera ajoutée à mon fichier ?
L'outil vise à augmenter le nombre total de lignes de 125 % grâce à des commentaires pédagogiques, avec une limite stricte de 400 nouvelles lignes.
L'outil modifiera-t-il la fonctionnalité ou le formatage de mon code ?
Non, l'outil est conçu pour maintenir la structure, l'encodage, l'indentation et la conformité de la compilation du fichier.
Que se passe-t-il si je ne fournis pas de nom de fichier ?
L'agent vous demandera de fournir un ou plusieurs fichiers, en proposant une liste numérotée de correspondances proches si plusieurs fichiers sont trouvés.