Melakukan refactor pada script Python menjadi proyek yang ramah bagi pemula dengan menambahkan komentar instruksional dan membuat tutorial README.md yang komprehensif.
- Bintang GitHub
- 41.038
- File
- 1
- Commit terakhir
- 11 Nov 2026
- Lisensi
- MIT
- Tool yang diizinkan
- —
Apa fungsi skill comment-code-generate-a-tutorial?
comment-code-generate-a-tutorial adalah agent skill. Melakukan refactor pada script Python menjadi proyek yang ramah bagi pemula dengan menambahkan komentar instruksional dan membuat tutorial README.md yang komprehensif.
Ringkasan dibuat dari SKILL.md skill ini.
Tentang skill comment-code-generate-a-tutorial
Fungsi utama dari tool ini adalah mengubah script Python mentah menjadi sumber daya edukasi bagi developer baru. Tool ini mengambil script yang sudah ada dan menerapkan panduan gaya PEP 8 untuk memastikan kode mengikuti praktik terbaik Python standar. Dengan mengganti nama variabel dan fungsi yang tidak jelas, skill ini menghasilkan versi logika asli yang lebih bersih dan lebih mudah diikuti oleh siswa.
Seorang agent harus memuat skill ini ketika pengguna perlu mengubah satu file menjadi paket proyek yang lengkap. Prosesnya melibatkan penyisipan komentar instruksional yang menjelaskan alasan di balik logika tersebut, bukan sekadar sintaksisnya. Terakhir, skill ini menghasilkan file README.md yang berisi ringkasan proyek, instruksi setup, penjelasan cara kerja kode, dan cuplikan contoh penggunaan. Hal ini mengubah script sederhana menjadi modul pembelajaran yang terstruktur.
Apa yang bisa dilakukan agent dengannya
- 1Mengonversi script menjadi proyek edukasiMengubah satu script Python menjadi proyek yang rapi dan ramah pemula lengkap dengan komentar instruksional dan tutorial.
- 2Membuat dokumentasi proyek yang komprehensifMenghasilkan file README.md yang mencakup instruksi setup, penjelasan logika, dan contoh penggunaan.
Ditulis dari SKILL.md milik skill tersebut. Setiap use case diverifikasi dengan kutipan darinya.
Cara install skill comment-code-generate-a-tutorial
Setiap perintah menyalin folder skill ke direktori skills client. Restart client atau mulai sesi baru untuk memuatnya.Install skill comment-code-generate-a-tutorial di Claude Code
~/.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorialInstall skill comment-code-generate-a-tutorial di Claude Code (project)
.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial .claude/skills/comment-code-generate-a-tutorialInstall skill comment-code-generate-a-tutorial di Codex
~/.agents/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.agents/skills/comment-code-generate-a-tutorialInstall skill comment-code-generate-a-tutorial di Gemini CLI
~/.gemini/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.gemini/skills/comment-code-generate-a-tutorialInstall skill comment-code-generate-a-tutorial di Claude.ai
npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial comment-code-generate-a-tutorial && zip -r comment-code-generate-a-tutorial.zip comment-code-generate-a-tutorial # claude.ai → Customize → Skills → + → Create skill → Upload a skill → comment-code-generate-a-tutorial.zip
Pengecekan otomatis
Berjalan 14 Nov 2026Laporan lengkap →Lolos cek otomatis kami. Ini bukan audit keamanan: baca skripnya sebelum membiarkan agent menjalankannya. Cara kerja checks
- Source repository terhubung dan dapat dijangkaugithub/awesome-copilot/skills/comment-code-generate-a-tutorial is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/comment-c ↗Lolos
- Lisensi open source (OSI)MITspdx.org/licenses/MIT.html ↗Lolos
- Ada commit atau release dalam satu tahun terakhirLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Lolos
- Skrip tanpa unduh-lalu-jalankan atau pencurian kredensialNo scripts in the skill folderLolos
- Tidak ada instruksi tersembunyi di SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Lolos
- Tool yang diizinkan otomatis dibatasiNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Lolos
SKILL.md
Lihat di GitHubTransform 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
Berkas dalam skill ini
1Pertanyaan seputar skill comment-code-generate-a-tutorial
Bagaimana cara install skill comment-code-generate-a-tutorial di Claude Code?
Jalankan npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorial. Claude Code memuat skill dari ~/.claude/skills (semua proyek) atau .claude/skills (satu proyek) dan menggunakan skill saat deskripsinya cocok dengan tugas.
Client mana saja yang bisa menggunakan skill comment-code-generate-a-tutorial?
Client apa pun yang membaca format Agent Skills: Claude Code, Codex, Gemini CLI, dan claude.ai (unggah sebagai ZIP). Script dalam skill hanya berjalan di client yang mengizinkan eksekusi kode.
Standar coding apa yang diikuti oleh skill ini?
Skill ini memastikan bahwa kode yang di-refactor mengikuti panduan gaya PEP 8 dan menerapkan praktik terbaik Python standar.
Bagian apa saja yang disertakan dalam tutorial yang dihasilkan?
README.md yang dihasilkan mencakup ringkasan proyek, instruksi setup, penjelasan logika, contoh penggunaan, dan sampel output opsional.