mcpbeat

Comment Code Generate A Tutorial

github/comment-code-generate-a-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.

This is a copy. The original lives at christophacham/comment-code-generate-a-tutorial.

347 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
1
copies elsewhere
how many repositories repackaged it
37394
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository
npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial

The instruction itself

as written by 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.

  • 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

Repackaged in 1 other repositories

same content, different owner
christophacham/agent-skills-library open on GitHub →

How to use it

Copy the folder

Take github/comment-code-generate-a-tutorial from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.