{"id":"b7be1348-c322-4f0b-95d4-799abfd8e84d","shortId":"ScMMwb","kind":"skill","title":"comment-code-generate-a-tutorial","tagline":"Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown 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.\n\n1. **Refactor the code**  \n   - Apply standard Python best practices  \n   - Ensure code follows the PEP 8 style guide  \n   - Rename unclear variables and functions if needed for clarity\n\n1. **Add comments throughout the code**  \n   - Use a beginner-friendly, instructional tone  \n   - Explain what each part of the code is doing and why it's important  \n   - Focus on the logic and reasoning, not just syntax  \n   - Avoid redundant or superficial comments\n\n1. **Generate a tutorial as a `README.md` file**  \n   Include the following sections:\n   - **Project Overview:** What the script does and why it's useful  \n   - **Setup Instructions:** Prerequisites, dependencies, and how to run the script  \n   - **How It Works:** A breakdown of the code logic based on the comments  \n   - **Example Usage:** A code snippet showing how to use it  \n   - **Sample Output:** (Optional) Include if the script returns visible results  \n   - Use clear, readable Markdown formatting","tags":["comment","code","generate","tutorial","awesome","copilot","github","agent-skills","agents","custom-agents","github-copilot","hacktoberfest"],"capabilities":["skill","source-github","skill-comment-code-generate-a-tutorial","topic-agent-skills","topic-agents","topic-awesome","topic-custom-agents","topic-github-copilot","topic-hacktoberfest","topic-prompt-engineering"],"categories":["awesome-copilot"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/github/awesome-copilot/comment-code-generate-a-tutorial","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add github/awesome-copilot","source_repo":"https://github.com/github/awesome-copilot","install_from":"skills.sh"}},"qualityScore":"0.700","qualityRationale":"deterministic score 0.70 from registry signals: · indexed on github topic:agent-skills · 33270 github stars · SKILL.md body (1,146 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-18T18:52:07.071Z","embedding":null,"createdAt":"2026-04-18T20:26:03.647Z","updatedAt":"2026-05-18T18:52:07.071Z","lastSeenAt":"2026-05-18T18:52:07.071Z","tsv":"'1':57,83,124 '8':71 'ad':22,47 'add':84 'appli':61 'avoid':119 'base':166 'beginn':15,40,92 'beginner-friend':14,39,91 'best':64 'breakdown':161 'clariti':82 'clear':23,48,191 'code':3,21,46,60,67,88,102,164,173 'comment':2,25,50,85,123,169 'comment-code-generate-a-tutori':1 'complet':29,54 'depend':150 'ensur':66 'exampl':170 'explain':96 'file':131 'focus':110 'follow':68,134 'format':194 'friend':16,41,93 'function':78 'generat':4,27,52,125 'guid':73 'import':109 'includ':132,183 'instruct':24,49,94,148 'logic':113,165 'markdown':30,55,193 'need':80 'option':182 'output':181 'overview':137 'part':99 'pep':70 'polish':13,38 'practic':65 'prerequisit':149 'project':17,42,136 'python':9,34,63 'readabl':192 'readme.md':130 'reason':115 'redund':120 'refactor':19,44,58 'renam':74 'result':189 'return':187 'run':154 'sampl':180 'script':10,35,140,156,186 'section':135 'setup':147 'show':175 'skill' 'skill-comment-code-generate-a-tutorial' 'snippet':174 'source-github' 'standard':62 'style':72 'superfici':122 'syntax':118 'throughout':86 'tone':95 'topic-agent-skills' 'topic-agents' 'topic-awesome' 'topic-custom-agents' 'topic-github-copilot' 'topic-hacktoberfest' 'topic-prompt-engineering' 'transform':7,32 'tutori':6,31,56,127 'unclear':75 'usag':171 'use':89,146,178,190 'variabl':76 'visibl':188 'work':159","prices":[{"id":"6778626f-a624-4a04-ac15-b2fb2a6d1f27","listingId":"b7be1348-c322-4f0b-95d4-799abfd8e84d","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"github","category":"awesome-copilot","install_from":"skills.sh"},"createdAt":"2026-04-18T20:26:03.647Z"}],"sources":[{"listingId":"b7be1348-c322-4f0b-95d4-799abfd8e84d","source":"github","sourceId":"github/awesome-copilot/comment-code-generate-a-tutorial","sourceUrl":"https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial","isPrimary":false,"firstSeenAt":"2026-04-18T21:48:38.481Z","lastSeenAt":"2026-05-18T18:52:07.071Z"},{"listingId":"b7be1348-c322-4f0b-95d4-799abfd8e84d","source":"skills_sh","sourceId":"github/awesome-copilot/comment-code-generate-a-tutorial","sourceUrl":"https://skills.sh/github/awesome-copilot/comment-code-generate-a-tutorial","isPrimary":true,"firstSeenAt":"2026-04-18T20:26:03.647Z","lastSeenAt":"2026-05-07T22:40:18.628Z"}],"details":{"listingId":"b7be1348-c322-4f0b-95d4-799abfd8e84d","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"github","slug":"comment-code-generate-a-tutorial","github":{"repo":"github/awesome-copilot","stars":33270,"topics":["agent-skills","agents","ai","awesome","custom-agents","github-copilot","hacktoberfest","prompt-engineering"],"license":"mit","html_url":"https://github.com/github/awesome-copilot","pushed_at":"2026-05-18T01:26:59Z","description":"Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.","skill_md_sha":"6ba8f399ad090cf7e75b9abac1e9c01f1b969cc3","skill_md_path":"skills/comment-code-generate-a-tutorial/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/github/awesome-copilot/tree/main/skills/comment-code-generate-a-tutorial"},"layout":"multi","source":"github","category":"awesome-copilot","frontmatter":{"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."},"skills_sh_url":"https://skills.sh/github/awesome-copilot/comment-code-generate-a-tutorial"},"updatedAt":"2026-05-18T18:52:07.071Z"}}