comment-code-generate-a-tutorial

작성자: github

파이썬 스크립트를 초보자 친화적인 프로젝트로 리팩토링하고, 설명용 주석과 마크다운 튜토리얼을 추가합니다. PEP 8 스타일 가이드 준수 및 표준 파이썬 모범 사례를 적용하여 코드 품질을 개선합니다. 학습자를 위해 코드 전반에 걸쳐 로직, 근거, 중요성을 설명하는 설명용 주석을 추가합니다. 프로젝트 개요, 설정 방법, 코드 분석, 사용 예제, 샘플 출력을 포함한 완전한 README.md 튜토리얼을 생성합니다. 불명확한 변수 및 함수 이름을 명확하게 변경합니다...

npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial

ZIP 다운로드 GitHub

37.7k

Transform 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.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