Kod dosyalarını, belirli bilgi seviyelerine göre uyarlanmış, bağlam duyarlı eğitici yorumlar ekleyerek öğrenme kaynaklarına dönüştürür.
- GitHub yıldızları
- 41.038
- Dosyalar
- 1
- Son commit
- 11 Kas 2026
- Lisans
- MIT
- İzin verilen araçlar
- —
add-educational-comments skill ne işe yarar?
Kod dosyalarını, belirli bilgi seviyelerine göre uyarlanmış, bağlam duyarlı eğitici yorumlar ekleyerek öğrenme kaynaklarına dönüştürür.
Özet, skill'in SKILL.md dosyasından oluşturuldu.
add-educational-comments skilli hakkında
Kaynak kodunu etkileşimli öğrenme materyallerine dönüştürmek, bu SKILL'in temel işlevidir. Mevcut dosyaları, doğrudan kodun içine bağlam duyarlı açıklamalar enjekte ederek eğitici kaynaklara dönüştürmek isteyen geliştiriciler ve öğrenciler için tasarlanmıştır. Bir kullanıcı bir dosya sağladığında ve o dosyadaki sözdizimi, tasarım seçimleri veya mimari desenler hakkında daha derinlemesine bilgi talep ettiğinde, agent bu aracı yüklemelidir.
Süreç, kodu analiz etmeyi ve belirli deyimlerin veya dilin iç işleyişinin arkasındaki mantığı açıklayan yorumlar eklemeyi içerir. Araç, bu notlar aracılığıyla dosya uzunluğunu %125 oranında artırmayı hedefler, ancak aşırı şişkinliği önlemek için 400 yeni satırlık kesin bir sınıra uyar. Python, Haskell, F#, Nim, Cobra, YAML ve Makefiles dahil olmak üzere çeşitli programlama dillerini destekler.
Kullanıcılar; Yorum Detayı, Tekrarlanabilirlik ve 1 ile 3 arasında değişen Kullanıcı Bilgi seviyeleri gibi belirli parametreler aracılığıyla deneyimi özelleştirebilirler. SKILL ayrıca, ilgili açıklamaları birbirine bağlamak için Satır Numarası Referansı sunar ve düzgün girintiyi ve okunabilirliği korumak için yorumları kod blokları içinde iç içe geçirebilir.
Bir agent bununla neler yapabilir
- 1Junior geliştiricileri işe alıştırmaYeni başlayanlar için temel açıklamalar ekleyerek karmaşık bir kod tabanını rehberli bir eğitime dönüştürün.
- 2Dil uzmanlığını derinleştirmeİleri düzey uygulayıcılar için performans ve mimari ile ilgili teknik bağlam ekleyin.
- 3Teknik dokümantasyonu standartlaştırmaOrijinal kodlama ve girinti stillerini korurken dosyalara tutarlı eğitici notlar uygulayın.
- 4Yapılandırılmış çalışma kılavuzları oluşturmaDosya genelinde ilgili programlama kavramlarını birbirine bağlamak için numaralandırılmış bir not dizisi oluşturun.
Skill'in SKILL.md dosyasından yazılmıştır. Her kullanım durumu oradaki bir alıntı ile kontrol edilir.
add-educational-comments skill nasıl kurulur
Her komut, skill klasörünü istemcinin skills dizinine kopyalar. Yüklemek için istemciyi yeniden başlatın veya yeni bir oturum başlatın.add-educational-comments skill'ini Claude Code uygulamasına kur
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsadd-educational-comments skill'ini Claude Code (project) uygulamasına kur
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsadd-educational-comments skill'ini Codex uygulamasına kur
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsadd-educational-comments skill'ini Gemini CLI uygulamasına kur
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsadd-educational-comments skill'ini Claude.ai uygulamasına kur
npx degit github/awesome-copilot/skills/add-educational-comments add-educational-comments && zip -r add-educational-comments.zip add-educational-comments # claude.ai → Customize → Skills → + → Create skill → Upload a skill → add-educational-comments.zip
Otomatik kontroller
Çalıştırıldı 15 Kas 2026Tam rapor →Otomatik kontrollerimizi geçti. Bu bir güvenlik denetimi değil: bir ajanın çalıştırmasına izin vermeden önce betikleri okuyun. Kontroller nasıl çalışır · Daha fazla puan için nelerin düzeltileceği
- Kaynak deposu bağlantılı ve erişilebilirgithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Geçti
- Açık kaynak lisansı (OSI)MITspdx.org/licenses/MIT.html ↗Geçti
- Son bir yıl içinde commit veya sürüm mevcutLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Geçti
- Betiklerde indir-çalıştır veya kimlik bilgisi hırsızlığı yokNo scripts in the skill folderGeçti
- SKILL.md içinde gizli talimat yokNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Geçti
- Önceden izin verilen araçlar sınırlıNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Geçti
- SKILL.md, Agent Skills biçimine uyuyorthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Bulgu
SKILL.md
GitHub'da görüntüleAdd Educational Comments
Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.
Role
You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.
- Provide foundational explanations for beginners
- Add practical insights and best practices for intermediate users
- Offer deeper context (performance, architecture, language internals) for advanced users
- Suggest improvements only when they meaningfully support understanding
- Always obey the Educational Commenting Rules
Objectives
- Transform the provided file by adding educational comments aligned with the configuration.
- Maintain the file's structure, encoding, and build correctness.
- Increase the total line count by 125% using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
Line Count Guidance
- Default: add lines so the file reaches 125% of its original length.
- Hard limit: never add more than 400 educational comment lines.
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.
Educational Commenting Rules
Encoding and Formatting
- Determine the file's encoding before editing and keep it unchanged.
- Use only characters available on a standard QWERTY keyboard.
- Do not insert emojis or other special symbols.
- Preserve the original end-of-line style (LF or CRLF).
- Keep single-line comments on a single line.
- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.).
- When instructed with
Line Number Referencing = yes, prefix each new comment withNote <number>(e.g.,Note 1).
Content Expectations
- Focus on lines and blocks that best illustrate language or platform concepts.
- Explain the "why" behind syntax, idioms, and design choices.
- Reinforce previous concepts only when it improves comprehension (
Repetitiveness). - Highlight potential improvements gently and only when they serve an educational purpose.
- If
Line Number Referencing = yes, use note numbers to connect related explanations.
Safety and Compliance
- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution.
- Avoid introducing syntax errors (for example, Python encoding errors per PEP 263).
- Input data as if typed on the user's keyboard.
Workflow
- Confirm Inputs – Ensure at least one target file is provided. If missing, respond with:
Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. - Identify File(s) – If multiple matches exist, present an ordered list so the user can choose by number or name.
- Review Configuration – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g.,
Line Numer) using context. - Plan Comments – Decide which sections of the code best support the configured learning goals.
- Add Comments – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
- Validate – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
Configuration Reference
Properties
- Numeric Scale:
1-3 - Numeric Sequence:
ordered(higher numbers represent higher knowledge or intensity)
Parameters
- File Name (required): Target file(s) for commenting.
- Comment Detail (
1-3): Depth of each explanation (default2). - Repetitiveness (
1-3): Frequency of revisiting similar concepts (default2). - Educational Nature: Domain focus (default
Computer Science). - User Knowledge (
1-3): General CS/SE familiarity (default2). - Educational Level (
1-3): Familiarity with the specific language or framework (default1). - Line Number Referencing (
yes/no): Prepend comments with note numbers whenyes(defaultyes). - Nest Comments (
yes/no): Whether to indent comments inside code blocks (defaultyes). - Fetch List: Optional URLs for authoritative references.
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your Educational Role to interpret them sensibly and still achieve the objective.
Default Configuration
- File Name
- Comment Detail = 2
- Repetitiveness = 2
- Educational Nature = Computer Science
- User Knowledge = 2
- Educational Level = 1
- Line Number Referencing = yes
- Nest Comments = yes
- Fetch List:
Examples
Missing File
[user]
> /add-educational-comments
[agent]
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
Custom Configuration
[user]
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
Interpret Line Numer = no as Line Number Referencing = no and adjust behavior accordingly while maintaining all rules above.
Final Checklist
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
- Keep encoding, end-of-line style, and indentation unchanged.
- Confirm all educational comments follow the configuration and the Educational Commenting Rules.
- Provide clarifying suggestions only when they aid learning.
- When a file has been processed before, refine existing comments instead of expanding line count.
Bu becerideki dosyalar
1add-educational-comments skill soruları
add-educational-comments skill'ini Claude Code uygulamasına nasıl kurarım?
npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments komutunu çalıştırın. Claude Code, skill'leri ~/.claude/skills (tüm projeler) veya .claude/skills (tek proje) konumundan yükler ve açıklaması görevle eşleştiğinde skill'i kullanır.
add-educational-comments skill'ini hangi istemciler kullanabilir?
Agent Skills biçimini okuyan her istemci: Claude Code, Codex, Gemini CLI ve claude.ai (ZIP olarak yükleyin). Skill içindeki betikler yalnızca istemcinin kod çalıştırmaya izin verdiği yerlerde çalışır.
Dosyama ne kadar içerik eklenecek?
Araç, eğitici yorumlar kullanarak toplam satır sayısını %125 oranında artırmayı hedefler; ancak aşırı şişkinliği önlemek için 400 yeni satır sınırı uygulanır.
Araç kodumun işlevselliğini veya formatını değiştirecek mi?
Hayır, araç dosyanın yapısını, kodlamasını, girintilerini ve derleme doğruluğunu koruyacak şekilde tasarlanmıştır.
Bir dosya adı sağlamazsam ne olur?
Agent sizden bir veya birden fazla dosya sağlamanızı isteyecektir; birden fazla dosya bulunursa size en yakın eşleşmelerden oluşan numaralandırılmış bir liste sunacaktır.