comment-code-generate-a-tutorial

by github

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... npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial Download ZIPGitHub36.2k 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