SkillHub

Skills github awesome-copilot

comment-code-generate-a-tutorial

Use it when:
You have a working Python script and want to share it with beginners as a teaching project.
It does:
Refactors it to PEP 8 with clearer names, then adds comments that explain what each part does and why.
You get:
The commented script and a README.md tutorial: overview, setup, how it works, example usage and optional sample output.

TL;DR

A one-shot prompt for a Python script. The agent first refactors it by standard Python practice and the PEP 8 style guide, renaming unclear variables and functions. It then comments the code throughout in a beginner-friendly, instructional tone, explaining the logic and the reasons behind it rather than the syntax, and skipping redundant comments. Last, it writes a README.md tutorial: what the script does and why it's useful, prerequisites, dependencies and how to run it, a breakdown of the logic based on the comments, an example of using it, and sample output when the script shows results.

Summarizes the skill at 797337f.

npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial

skills.sh pageSource on GitHubAll skills from github/awesome-copilot

Total Downloads
8,900 on skills.sh, Nov 9, 2026
Repo stars
40,943 github/awesome-copilot
First seen
Feb 25, 2026 on skills.sh
Weekly Downloads
2
-78% over the 8 weeks to Nov 9
Weekly values
Week toInstalls
Sep 219
Sep 2816
Oct 516
Oct 123
Oct 194
Oct 262
Nov 21
Nov 92
Category
category:writing

Articles, docs, internal comms, research write-ups and prose that doesn't read as generated.
Type
type:command

A one-shot action you invoke by name, such as turning the conversation into a PRD.
Effect
effect:local

Its own steps create or change files, git state or local tools.
Needs
needs:none

Instructions only. Works in any agent that supports skills.
Publisher
by:official

A verified publisher on skills.sh, or the company or maintainer behind the product the skill operates.
Topics
docs-writinglearningrefactoring
Stack
stack:python

SKILL.md

From github/awesome-copilot at 797337f. Checked daily, last changed Nov 6, 2026.

Frontmatter
name: comment-code-generate-a-tutorial
description: '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