Refactorise des scripts Python en projets accessibles aux débutants en ajoutant des commentaires pédagogiques et en générant un tutoriel complet dans le README.md.
- Étoiles GitHub
- 41 038
- Fichiers
- 1
- Dernier commit
- 11 nov. 2026
- Licence
- MIT
- Outils autorisés
- —
Que fait la skill comment-code-generate-a-tutorial ?
comment-code-generate-a-tutorial est une agent skill. Refactorise des scripts Python en projets accessibles aux débutants en ajoutant des commentaires pédagogiques et en générant un tutoriel complet dans le README.md.
Résumé généré à partir du SKILL.md de la skill.
À propos du skill comment-code-generate-a-tutorial
La fonction principale de cet outil est de transformer des scripts Python bruts en ressources pédagogiques pour les nouveaux développeurs. Il prend un script existant et applique les directives de style PEP 8 pour s'assurer que le code suit les meilleures pratiques standards de Python. En renommant les variables et les fonctions peu explicites, le SKILL produit une version plus propre de la logique originale, plus facile à suivre pour les étudiants.
Un agent doit charger ce SKILL lorsqu'un utilisateur souhaite transformer un fichier unique en un package de projet complet. Le processus consiste à injecter des commentaires pédagogiques qui expliquent le raisonnement derrière la logique plutôt que la simple syntaxe. Enfin, le SKILL génère un fichier README.md contenant une présentation du projet, les instructions d'installation, une analyse du fonctionnement du code et des extraits d'exemples d'utilisation. Cela transforme un simple script en un module d'apprentissage structuré.
Ce qu'un agent peut faire avec
- 1Convertir des scripts en projets éducatifsTransformez un script Python unique en un projet soigné et accessible aux débutants, avec des commentaires pédagogiques et un tutoriel.
- 2Créer une documentation de projet complèteGénérez un fichier README.md incluant les instructions d'installation, l'analyse de la logique et des exemples d'utilisation.
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 comment-code-generate-a-tutorial
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 comment-code-generate-a-tutorial dans Claude Code
~/.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorialInstaller la skill comment-code-generate-a-tutorial dans Claude Code (project)
.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial .claude/skills/comment-code-generate-a-tutorialInstaller la skill comment-code-generate-a-tutorial dans Codex
~/.agents/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.agents/skills/comment-code-generate-a-tutorialInstaller la skill comment-code-generate-a-tutorial dans Gemini CLI
~/.gemini/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.gemini/skills/comment-code-generate-a-tutorialInstaller la skill comment-code-generate-a-tutorial dans Claude.ai
npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial comment-code-generate-a-tutorial && zip -r comment-code-generate-a-tutorial.zip comment-code-generate-a-tutorial # claude.ai → Customize → Skills → + → Create skill → Upload a skill → comment-code-generate-a-tutorial.zip
Vérifications automatisées
Exécuté le 14 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
- Dépôt source lié et accessiblegithub/awesome-copilot/skills/comment-code-generate-a-tutorial is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/comment-c ↗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/comment-c ↗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/comment-c ↗Réussi
SKILL.md
Voir sur GitHubTransform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
-
Refactor the code
- Apply standard Python best practices
- Ensure code follows the PEP 8 style guide
- Rename unclear variables and functions if needed for clarity
-
Add comments throughout the code
- Use a beginner-friendly, instructional tone
- Explain what each part of the code is doing and why it's important
- Focus on the logic and reasoning, not just syntax
- Avoid redundant or superficial comments
-
Generate a tutorial as a
README.mdfile
Include the following sections:- Project Overview: What the script does and why it's useful
- Setup Instructions: Prerequisites, dependencies, and how to run the script
- How It Works: A breakdown of the code logic based on the comments
- Example Usage: A code snippet showing how to use it
- Sample Output: (Optional) Include if the script returns visible results
- Use clear, readable Markdown formatting
Fichiers de cette skill
1Questions sur la skill comment-code-generate-a-tutorial
Comment installer la skill comment-code-generate-a-tutorial dans Claude Code ?
Exécutez npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorial. 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 comment-code-generate-a-tutorial ?
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.
Quelles normes de codage ce SKILL respecte-t-il ?
Ce SKILL garantit que le code refactorisé respecte le guide de style PEP 8 et applique les meilleures pratiques standards de Python.
Quelles sections sont incluses dans le tutoriel généré ?
Le README.md généré comprend une présentation du projet, les instructions d'installation, une analyse de la logique, des exemples d'utilisation et, en option, un exemple de résultat.