General
35 installs
comment-code-generate-a-tutorial
by github/awesome-copilot
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete…
Skill content
Refactor Python scripts into beginner-friendly projects with instructional comments and markdown tutorials. - Applies PEP 8 style guide compliance and standard Python best practices to improve code quality - Adds instructional comments throughout the code explaining logic, reasoning, and importance for learners - Generates a complete README.md tutorial with project overview, setup instructions, code breakdown, usage examples, and sample output - Renames unclear variables and functions for clarity while maintaining functionality 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