comment-code-generate-a-tutorial

por github

Refatore scripts Python em projetos amigáveis para iniciantes, com comentários instrutivos e tutoriais em markdown. Aplica conformidade com o guia de estilo PEP 8 e práticas recomendadas padrão do Python para melhorar a qualidade do código. Adiciona comentários instrutivos ao longo do código explicando lógica, raciocínio e importância para aprendizes. Gera um tutorial completo em README.md com visão geral do projeto, instruções de configuração, detalhamento do código, exemplos de uso e saída de exemplo. Renomeia variáveis e funções pouco claras para maior clareza...

npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial

Baixar ZIP GitHub

37.7k

Transform 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.md file
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