Coding & Refactoringlow risk

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.

github/awesome-copilot·skills/comment-code-generate-a-tutorial/SKILL.md
95/ 100Quality

Install this skill

Choose your coding agent and copy a project or personal installation command.

Pinned to the indexed commit
Project installation.agents/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a codex -y
Personal installation~/.agents/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a codex -g -y
Manual folder.agents/skills/comment-code-generate-a-tutorialOfficial docs ↗
Project installation.claude/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a claude-code -y
Personal installation~/.claude/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a claude-code -g -y
Manual folder.claude/skills/comment-code-generate-a-tutorialOfficial docs ↗
Project installation.agents/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a github-copilot -y
Personal installation~/.copilot/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a github-copilot -g -y
Manual folder.agents/skills/comment-code-generate-a-tutorialOfficial docs ↗
Project installation.agents/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a cursor -y
Personal installation~/.cursor/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a cursor -g -y
Manual folder.agents/skills/comment-code-generate-a-tutorialOfficial docs ↗
Project installation.agents/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a gemini-cli -y
Personal installation~/.gemini/skills/comment-code-generate-a-tutorial
npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/comment-code-generate-a-tutorial -a gemini-cli -g -y
Native Gemini CLIgemini skills install https://github.com/github/awesome-copilot.git --scope workspace --path skills/comment-code-generate-a-tutorial
Manual folder.agents/skills/comment-code-generate-a-tutorialOfficial docs ↗
⚠ Installation uses the open-source skills CLI. Inspect the source and permissions before running the command.

Skill instructions

View source on GitHub ↗
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

1. **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

1. **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