Index of every page on this site: llms.txt
All skills
github avatar

/comment-code-generate-a-tutorial

@f10fdb8 official
by githubgithub/awesome-copilot41k stars
5,399
Run it yourself

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

Use this Skill: https://skilld.dev/gh/github/awesome-copilot/comment-code-generate-a-tutorial

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈53 tokens for metadata: the name and description. ≈287 when used: this file.

Description uses 2.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈213 characters, or 2.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo5 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    The skill is safe to use. It is a text-based prompt template that guides the AI agent to refactoring a Python script, add instructional comments, and generate a README tutorial file.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer8mo

    1/1 file flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at f10fdb8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 9 months ago

README badge

README badge for github/awesome-copilot/comment-code-generate-a-tutorial

Refactors a Python script to meet PEP 8 standards, adds instructional comments explaining logic and reasoning, and generates a beginner-friendly README.md tutorial. Useful for documenting educational code examples or preparing scripts for sharing with junior developers.

Generated from the current SKILL.md.

Does this skill work with languages other than Python?
The skill is designed specifically for Python scripts. It applies PEP 8 style guidelines and Python best practices.
What does the generated tutorial include?
The skill generates a README.md with project overview, setup instructions, code logic breakdown, example usage, and optional sample output sections.
Does this refactor the code or just add comments?
The skill both refactors the code to follow PEP 8 and best practices, and adds instructional comments throughout. It also generates the tutorial markdown.
Who is the target audience for the generated tutorial?
The skill generates tutorials aimed at beginners, using clear explanations focused on logic and reasoning rather than just syntax.

Generated from the current SKILL.md. These answers refresh after source changes.