Skill Store 33

Comment Code Generate A Tutorial

Transform this Python script into a polished, beginner-friendly project by refactoring the code,…

by github · MIT

The skill

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

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

Use this skill

Connect your agent to the Skill Store MCP server and ask for it by ref: github/comment-code-generate-a-tutorial-59307586711.

Download SKILL.md · Markdown version

Details

Publisher
github
Category
Software Development › Developer docs & tooling
License
MIT
Updated
2026-10-16

References

More from github