comment-code-generate-a-tutorial
Tái cấu trúc các tập lệnh Python thành các dự án thân thiện với người mới bắt đầu, kèm theo chú thích hướng dẫn và hướng dẫn markdown. Áp dụng tuân thủ hướng dẫn phong cách PEP 8 và các phương pháp thực hành Python tiêu chuẩn để cải thiện chất lượng mã. Thêm các chú thích hướng dẫn xuyên suốt mã giải thích logic, lý do và tầm quan trọng cho người học. Tạo một hướng dẫn README.md hoàn chỉnh với tổng quan dự án, hướng dẫn thiết lập, phân tích mã, ví dụ sử dụng và đầu ra mẫu. Đổi tên các biến và hàm không rõ ràng để rõ ràng hơn...
npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorialTransform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
-
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
-
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
-
Generate a tutorial as a
README.mdfile
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