comment-code-generate-a-tutorial
Refactoriza scripts de Python en proyectos aptos para principiantes con comentarios instructivos y tutoriales en markdown. Aplica cumplimiento de la guía de estilo PEP 8 y las mejores prácticas estándar de Python para mejorar la calidad del código. Agrega comentarios instructivos a lo largo del código explicando la lógica, el razonamiento y la importancia para los estudiantes. Genera un tutorial completo en README.md con una visión general del proyecto, instrucciones de configuración, desglose del código, ejemplos de uso y resultados de muestra. Renombra variables y funciones poco claras para mayor claridad...
npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorialTransform 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