comment-code-generate-a-tutorial by github

Decision brief

What it does—and where it fits

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

Best for

Not for

Tasks that require unconfirmed production actions or broad system permissions.
Environments where the pinned source and install steps cannot be inspected.

Compatibility matrix

Platform support, with evidence labels

Platform	Status	Evidence	What to check
Codex	Not declared	No explicit evidence	Portability before use
Claude Code	Not declared	No explicit evidence	Portability before use
Cursor	Not declared	No explicit evidence	Portability before use
Gemini CLI	Not declared	No explicit evidence	Portability before use

Open the compatibility checker

Installation

Inspect first. Install second.

The source command is displayed only when detected. A safe inspection prompt is always available so your agent can explain every action before execution.

Source-detected install commandSource

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

Safe inspection promptEditorial

Inspect the Agent Skill "comment-code-generate-a-tutorial" from https://github.com/github/awesome-copilot/blob/9933dcad5be5caeb288cebcd370eeeb2fc2f1685/skills/comment-code-generate-a-tutorial/SKILL.md at commit 9933dcad5be5caeb288cebcd370eeeb2fc2f1685. List every install step, command, network request, credential, file read/write, external action, and rollback step. Explain whether it fits my task. Do not install or execute anything until I approve.

Workflow

What the source asks the agent to do

The source does not provide enough structured workflow evidence for a step-by-step guide.

Permission review

Static risk signals and limitations

Runs scripts

medium · line 17

The documentation asks the agent to run terminal commands or scripts.

**Setup Instructions:** Prerequisites, dependencies, and how to run the script

Evidence record

Why each signal appears

EvidenceSourceComputedTestedEditorial

Signal	Value	Evidence type	Meaning
Quality score	67/100	Computed	Documentation, specificity, maintenance, and trust rules
Repository stars	37,126	Source	Repository attention, not individual Skill quality
Compatibility	0 platforms	Source	Declared in the catalog source record
Usage guide	catalog record	Editorial	Generated or reviewed according to the visible evidence level

Pinned source

Provenance and original SKILL.md

Repository: github/awesome-copilot
Skill path: skills/comment-code-generate-a-tutorial/SKILL.md
Commit: 9933dcad5be5caeb288cebcd370eeeb2fc2f1685
License: MIT
Collected: 2026-07-28
Default branch: main

View the original 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.

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

comment-code-generate-a-tutorial