{"id":"9b425001-a785-4b86-92d0-a67109aba27e","slug":"comment-code-generate-a-tutorial","kind":"skill","name":"comment-code-generate-a-tutorial","summary":"Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.","owner":"github","repoUrl":"https://github.com/github/awesome-copilot/tree/HEAD/skills/comment-code-generate-a-tutorial","license":"MIT","licenseTier":"permissive","trust":"official","stars":39994,"match":null,"fewStars":false,"format":"skill","createdAt":null,"addedAt":"2026-10-14T05:09:43.869Z","logoUrl":"https://avatars.githubusercontent.com/u/9919?v=4","linkOnly":false,"collection":{"name":"awesome-copilot","repo":"github/awesome-copilot"},"skillPath":"skills/comment-code-generate-a-tutorial","categories":["developer-tools","files-documents"],"tags":["ai","github-copilot","prompt-engineering","hacktoberfest","agents","awesome","custom-agents"],"runtime":"binary","local":true,"cloudCapable":false,"cloudCapability":"unknown","cloudReadyOnPlatform":false,"needsApiKey":false,"reviewed":false,"syncedAt":"2026-10-14T05:09:43.865Z","sample":false,"url":"https://conduits.dev/tools/comment-code-generate-a-tutorial","language":"JavaScript","transports":[],"install":{},"requirements":{"env":[],"upstreamMayCharge":false},"tools":null,"readme":"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"}