Dignified Python Standards
docling-project/docling
Applies opinionated production Python conventions chosen by the project's Python version: modern type syntax, pathlib, explicit checks and interface guidance.
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
Install Comment Code Generate A Tutorial
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorial --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .claude/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .claude/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorialType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorial --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .agents/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .agents/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorial --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .cursor/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .cursor/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/github/awesome-copilot.git --path skills/comment-code-generate-a-tutorial--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorial --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .gemini/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .gemini/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorialInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .github/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .github/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install github/awesome-copilot comment-code-generate-a-tutorial --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/comment-code-generate-a-tutorial .opencode/skills/comment-code-generate-a-tutorial && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "comment-code-generate-a-tutorial" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial into .opencode/skills/comment-code-generate-a-tutorial/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "comment-code-generate-a-tutorial", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
comment-code-generate-a-tutorial- GitHub stars
- 40k
- Used in
- 1 other repo
- Token cost
- ~348 tokens
- SKILL.md length
- 157 words
- Files
- 1
- Skills in repo
- 417
- Repo updated
- First seen
- Licence
- MIT
At a glance
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
- Works in 3 steps: Refactor the code → Add comments throughout the code → Generate a tutorial as a README.md file
- Tasks that involve Refactoring
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Tasks that involve Markdown
What it does
Comment Code Generate A Tutorial is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
Its SKILL.md is about 350 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Refactoring and Markdown. It works with Python. The repository describes itself as: Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot. The licence is MIT.
When your agent uses it
- Tasks that involve Refactoring
- Tasks that involve Markdown
Example prompts
- “/comment-code-generate-a-tutorial”
Requirements
- Python 3
Workflow steps
3 steps, taken from the first numbered list in SKILL.md.
- Refactor the code
- Add comments throughout the code
- Generate a tutorial as a README.md file
What it can do on your machine
Read from SKILL.md and the folder at commit 727ff2e. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Comment Code Generate A Tutorial loads about 348 tokens when it runs. Until then it costs about 53 tokens; SKILL.md has 157 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from github/awesome-copilot at commit 727ff2e, republished under its MIT licence (© github). 157 words, ~348 tokens.
Download SKILL.mdSave it as
.claude/skills/comment-code-generate-a-tutorial/SKILL.md (or your agent's skills folder).- 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.
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.mdfile
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
© github, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in skills/comment-code-generate-a-tutorial of github/awesome-copilot.
Open the folder on GitHubat commit 727ff2e
Used in 1 other repository
We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in github/awesome-copilot, which our catalogue first saw on October 7, 2026.
Compare with similar skills
Comment Code Generate A Tutorial next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Comment Code Generate A Tutorial this skillgithub/awesome-copilot | 40k | 1 repos | ~348 | Automated safety check: Pass | MIT | |
| Dignified Python Standardsdocling-project/docling | 68k | — | ~1.5k | Automated safety check: Pass | Apache-2.0 | |
| Readable Pycrazyguitar/pysheeet | 8.2k | — | ~2.4k | Automated safety check: Pass | MIT | |
| Nexus MapperHaaaiawd/Nexus-skills | 166 | 1 repos | ~2.5k | Automated safety check: Notes | None | |
| Refactor OpCVCUDA/CV-CUDA | 2.7k | — | ~1.5k | Automated safety check: Pass | Custom licence | |
| Readable Verilog GeneratorEriemon/verilog-generator | 308 | — | ~5.4k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Readable Py
crazyguitar/pysheeet
Readable Python code rules inspired by The Art of Readable Code.
Nexus Mapper
Haaaiawd/Nexus-skills
Generate a persistent .nexus-map/ knowledge base that lets any AI session instantly understand a codebase's architecture, systems, dependencies, and change hotspots.
Refactor Op
CVCUDA/CV-CUDA
Find and safely apply per-operator refactoring / redundancy-reduction opportunities in a CV-CUDA operator (near-duplicate Tensor/VarShape kernels, reinvented shared utilities, dead code).
Readable Verilog Generator
Eriemon/verilog-generator
A skill your agent uses when creating, writing, reviewing, annotating, repairing, refactoring, or validating readable Verilog RTL, including synthesizable Verilog-2001 .v files, existing-RTL…
Docs Conventions
flet-dev/flet
A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…
More from github/awesome-copilot
All 417 skills in this repo- Official
Acquire Codebase Knowledge
github/awesome-copilot
Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.
- Official
Azure Architecture Autopilot
github/awesome-copilot
Designs Azure infrastructure from a natural-language description, or diagrams an existing resource group, then refines the design through conversation and deploys it with Bicep.
- Official
Draw.io Diagram Generator
github/awesome-copilot
Generates, edits and validates draw.io files with correct mxGraph XML, covering flowcharts, architecture, sequence, ER and UML class diagrams.
- Official
Credit Risk Data Cleaning
github/awesome-copilot
Cleans raw credit data and screens variables before loan modeling, dropping unstable, noisy or redundant features and writing an Excel report of every step.
- Official
Daily Focus Board
github/awesome-copilot
Builds a warm, browser-based daily focus board the user updates by talking to their agent, with Eisenhower priorities, a brain-dump box and kind not-today carryover.
- Official
Python Pypi Package Builder
github/awesome-copilot
End-to-end skill for building, testing, linting, versioning, and publishing a production-grade Python library to PyPI.
Related
Works with
Categories
Questions about Comment Code Generate A Tutorial
What does Comment Code Generate A Tutorial do?
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial. Comment Code Generate A Tutorial is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
When should I use Comment Code Generate A Tutorial?
Comment Code Generate A Tutorial fits situations like: tasks that involve Refactoring; tasks that involve Markdown.
How do I install Comment Code Generate A Tutorial in Claude Code?
Run `npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a claude-code`. Or copy the skill folder (skills/comment-code-generate-a-tutorial in github/awesome-copilot) into .claude/skills/comment-code-generate-a-tutorial in your project. Claude Code loads it when a task matches its description.
How do I install Comment Code Generate A Tutorial in Codex?
Run `npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a codex`. Or copy the skill folder (skills/comment-code-generate-a-tutorial in github/awesome-copilot) into .agents/skills/comment-code-generate-a-tutorial in your project. Codex loads it when a task matches its description.
Can I use Comment Code Generate A Tutorial in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorial -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/comment-code-generate-a-tutorial, .gemini/skills/comment-code-generate-a-tutorial, .github/skills/comment-code-generate-a-tutorial and .opencode/skills/comment-code-generate-a-tutorial in your project.
What does Comment Code Generate A Tutorial need to run?
SKILL.md names no scripts, command-line tools or credentials: Comment Code Generate A Tutorial is instructions for the agent only. Our summary lists: Python 3.
Does Comment Code Generate A Tutorial access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Comment Code Generate A Tutorial safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Comment Code Generate A Tutorial use?
Comment Code Generate A Tutorial is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Comment Code Generate A Tutorial use?
About 348 tokens (SKILL.md is roughly 1.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Comment Code Generate A Tutorial?
Skills that share tags, products or a category with Comment Code Generate A Tutorial: Dignified Python Standards (docling-project/docling, 68k stars), Readable Py (crazyguitar/pysheeet, 8.2k stars), Nexus Mapper (Haaaiawd/Nexus-skills, 166 stars) and Refactor Op (CVCUDA/CV-CUDA, 2.7k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Comment Code Generate A Tutorial?
github (a GitHub organization, an official publisher) maintains it in github/awesome-copilot, which has 39,748 GitHub stars. The repository holds 417 skills in this directory. The repository was last updated on October 7, 2026.
Source: github/awesome-copilot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.