Refatora scripts Python em projetos amigáveis para iniciantes, adicionando comentários instrutivos e gerando um tutorial completo em README.md.
- Estrelas no GitHub
- 41.038
- Arquivos
- 1
- Último commit
- 11 de nov. de 2026
- Licença
- MIT
- Ferramentas permitidas
- —
O que a skill comment-code-generate-a-tutorial faz?
comment-code-generate-a-tutorial é uma Agent Skill. Refatora scripts Python em projetos amigáveis para iniciantes, adicionando comentários instrutivos e gerando um tutorial completo em README.md.
Resumo gerado a partir do SKILL.md da skill.
Sobre a skill comment-code-generate-a-tutorial
Transformar scripts Python brutos em recursos educacionais para novos desenvolvedores é a função principal desta ferramenta. Ela pega um script existente e aplica as diretrizes de estilo PEP 8 para garantir que o código siga as melhores práticas padrão de Python. Ao renomear variáveis e funções pouco claras, a skill produz uma versão mais limpa da lógica original, facilitando o acompanhamento por estudantes.
Um agente deve carregar esta skill quando um usuário precisar transformar um único arquivo em um pacote de projeto completo. O processo envolve a inserção de comentários instrutivos que explicam o raciocínio por trás da lógica, em vez de apenas a sintaxe. Por fim, a skill gera um arquivo README.md contendo uma visão geral do projeto, instruções de configuração, uma análise de como o código funciona e snippets de exemplos de uso. Isso transforma um simples script em um módulo de aprendizado estruturado.
O que um agente pode fazer com ela
- 1Converter scripts em projetos educacionaisTransforme um único script Python em um projeto polido e amigável para iniciantes, com comentários instrutivos e um tutorial.
- 2Criar documentação de projeto abrangenteGere um arquivo README.md que inclua instruções de configuração, análise da lógica e exemplos de uso.
Escrito a partir do SKILL.md da skill. Cada caso de uso é verificado com uma citação dele.
Como instalar a skill comment-code-generate-a-tutorial
Cada comando copia a pasta da skill para o diretório de skills do cliente. Reinicie o cliente ou inicie uma nova sessão para carregá-la.Instalar a skill comment-code-generate-a-tutorial no 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-tutorialInstalar a skill comment-code-generate-a-tutorial no 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-tutorialInstalar a skill comment-code-generate-a-tutorial no 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-tutorialInstalar a skill comment-code-generate-a-tutorial no 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-tutorialInstalar a skill comment-code-generate-a-tutorial no 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
Verificações automatizadas
Executado em 14 de nov. de 2026Relatório completo →Passou nas nossas verificações automáticas. Não é uma auditoria de segurança: leia os scripts antes de deixar um agente executá-los. Como as verificações funcionam
- Repositório de origem vinculado e acessívelgithub/awesome-copilot/skills/comment-code-generate-a-tutorial is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/comment-c ↗Passou
- Licença de código aberto (OSI)MITspdx.org/licenses/MIT.html ↗Passou
- Commit ou release no último anoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Passou
- Sem baixar e executar nem roubo de credenciais nos scriptsNo scripts in the skill folderPassou
- Sem instruções ocultas no SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Passou
- Ferramentas pré-aprovadas são restritasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Passou
SKILL.md
Ver no 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
Arquivos desta skill
1Perguntas sobre a skill comment-code-generate-a-tutorial
Como instalo a skill comment-code-generate-a-tutorial no Claude Code?
Execute npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorial. O Claude Code carrega skills de ~/.claude/skills (todos os projetos) ou .claude/skills (um projeto) e usa uma skill quando a descrição dela corresponde à tarefa.
Quais clientes podem usar a skill comment-code-generate-a-tutorial?
Qualquer cliente que leia o formato Agent Skills: Claude Code, Codex, Gemini CLI e claude.ai (envie como ZIP). Scripts da skill são executados apenas onde o cliente permite execução de código.
Quais padrões de codificação esta skill segue?
A skill garante que o código refatorado siga o guia de estilo PEP 8 e aplique as melhores práticas padrão de Python.
Quais seções estão incluídas no tutorial gerado?
O README.md gerado inclui uma visão geral do projeto, instruções de configuração, uma análise da lógica, exemplos de uso e uma saída de exemplo opcional.