Comment code generate a tutorial
Skill github/awesome-copilot/skills/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.From its SKILL.md
npx -y skills add github/awesome-copilot --skill comment-code-generate-a-tutorialAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
SKILL.md
1.4 KB, 244 tokens by cl100k_base, as published. Nobody here has run it
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
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.
Gives 0 of the 12 instructions most technical docs skills give in 244 tokens
Counted across 160 of the 186 authors here whose files we hold, read 2026-09-06
- Review runbooks after every incidentin 6 of 160, across 4 files
- Test runbooks regularlyin 6 of 160, across 4 files
- Include rollback steps in every runbookin 6 of 160, across 4 files
- Clarify goals, constraints, and required inputsin 6 of 160, across 4 files
- Apply relevant best practices and validate outcomesin 6 of 160, across 4 files
- Provide actionable steps and verificationin 6 of 160, across 4 files
- Identify the audience before writingin 6 of 160
- Write short sentences in active voicein 6 of 160
- Open the implementation playbook for detailed examplesin 5 of 160, across 3 files
- Escalate early during incidentsin 5 of 160, across 3 files
- Keep stakeholders informedin 5 of 160, across 3 files
- Document assumptions in runbooksin 5 of 160, across 3 files
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.