AutoGineer
Generated banner for Comment Code Generate A Tutorial
Generated logo for Comment Code Generate A Tutorial

Comment Code Generate A Tutorial

GitHubOfficialOriginally contributed by @aaronpowell as prompts/comment-code-generate-a-tutorial.prompt.md; moved into a skill by pull request #761Distributed by GitHub

  • Skill
  • Content generator
  • Software development
  • MIT
  • No issues found
Download ZIP

From the author

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

From the skill’s files

Taken from the skill’s own files (its description, section headings and stated usage). Not an AutoGineer summary, and not written by the author as one.

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

What it does

  • 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

When to use it

The skill’s files do not state this.

Advantages

The skill’s files do not state this.

Usage examples

The skill’s files do not state this.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/github/comment-code-generate-a-tutorial/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip comment-code-generate-a-tutorial.zip -d .agents/skills

Documentation by aaronpowell

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

Files

SKILL.md

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

Requirements and compatibility

Written for: GitHub Copilot

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Originally contributed by
GitHub avatar of aaronpowell@aaronpowellas prompts/comment-code-generate-a-tutorial.prompt.mdmoved into a skill by pull request #761
Publisher
GitHub (Official)
Distributed by
GitHub
Source
github/awesome-copilot · skills/comment-code-generate-a-tutorial · commit 797337f
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Contributors
aaronpowell, jamesmontemagno

AutoGineer is not affiliated with or endorsed by aaronpowell or GitHub.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download comment-code-generate-a-tutorial.zip