github avatar

Comment Code Generate A Tutorial

The comment-code-generate-a-tutorial skill refactors Python scripts according to PEP 8 standards, adds instructional comments explaining code logic and reasoning, and generates a comprehensive markdown tutorial with setup instructions, usage examples, and project overview sections. It targets developers who want to transform rough scripts into polished, beginner-friendly projects with clear documentation. This skill solves the problem of making code accessible to learners by combining code quality improvements with thorough educational documentation.

skills.sh installs
8.9K
GitHub stars
41K
last updated
Aug 21, 2026

Install

$ npx -y skills add github/awesome-copilot --skill comment-code-generate-a-tutorial --agent claude-code

Installs into .claude/skills of the current project.

Files

Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.

  1. 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
  2. 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
  3. 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

Sponsors

Details

Repository
github.com/github/awesome-copilot
Categories
Git & Pull Requests, Documentation, Code Review & Quality, AI & Agent Building, Automation & Workflows, Python

More from github/awesome-copilot

All 318
1github avatarazure-resource-visualizergithub/awesome-copilotAnalyze Azure resource groups and generate detailed Mermaid architecture diagrams showing the relationships between individual resources. Use this skill when th8.9Kskills.sh installs
2github avatarcsharp-tunitgithub/awesome-copilotGet best practices for TUnit unit testing, including data-driven tests8.9Kskills.sh installs
3github avatarcode-exemplars-blueprint-generatorgithub/awesome-copilotTechnology-agnostic prompt generator that creates customizable AI prompts for scanning codebases and identifying high-quality code exemplars. Supports multiple 8.8Kskills.sh installs
4github avatarupdate-llmsgithub/awesome-copilotUpdate the llms.txt file in the root folder to reflect changes in documentation or specifications following the llms.txt specification at https://llmstxt.org/8.8Kskills.sh installs
5github avatarworkiq-copilotgithub/awesome-copilotGuides the Copilot CLI on how to use the WorkIQ CLI/MCP server to query Microsoft 365 Copilot data (emails, meetings, docs, Teams, people) for live context, sum8.8Kskills.sh installs
6github avatarcreate-tldr-pagegithub/awesome-copilotCreate a tldr page from documentation URLs and command examples, requiring both URL and command name.8.8Kskills.sh installs