6fb794bc79
* Delete outdated development instructions for Next.js + Tailwind and Python; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards. * Update documentation and prompts for consistency and clarity - Standardized description formatting in various markdown files to use single quotes. - Added error handling utility in update-readme.js for safer file operations. - Improved title extraction logic in update-readme.js to handle frontmatter more robustly. - Updated chat modes section in README to reflect new emoji and sorted chat mode links. - Cleaned up various instruction files for better readability and consistency. - Ensured all markdown files end with a newline for better compatibility with version control. * Remove standardize-frontmatter.js script * Add usage instructions for creating and switching chat modes in README.md * Update README.md generation script to enhance instructions and usage details for custom chat modes * Update README.md and update-readme.js for improved instruction clarity and consistency * Refactor README.md links and update readme script for improved clarity and consistency in instructions * Update README.md and update-readme.js for improved instruction clarity and consistency * Changing from a patch to regen approach for the readme * Bit more cleanup for how to show things in the readme * Adding missing description * Another missing description --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
26 lines
1.3 KiB
Markdown
26 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.'
|
|
---
|
|
|
|
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
|