2f3264bfc6
* Initial plan * Add mode: 'agent' to all 14 prompt files missing the field, fix BOM character Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> * Revert description field format changes while keeping mode field additions Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
---
|
|
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.'
|
|
mode: 'agent'
|
|
---
|
|
|
|
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
|