comment-code-generate-a-tutorial
Python betiklerini, açıklayıcı yorumlar ve markdown eğitimleriyle başlangıç seviyesine uygun projelere dönüştürür. Kod kalitesini artırmak için PEP 8 stil kılavuzu uyumluluğu ve standart Python en iyi uygulamalarını uygular. Öğrenciler için mantığı, gerekçeyi ve önemi açıklayan kod boyunca açıklayıcı yorumlar ekler. Proje genel bakışı, kurulum talimatları, kod dökümü, kullanım örnekleri ve örnek çıktı içeren eksiksiz bir README.md eğitimi oluşturur. Net olmayan değişken ve fonksiyon adlarını anlaşılır olacak şekilde yeniden adlandırır...
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