Skip to content

README.md

Latest commit

 

History

History
38 lines (30 loc) · 1.41 KB

README.md

File metadata and controls

38 lines (30 loc) · 1.41 KB
Raw

GitHub Analyzer Skill Resources

Author: Yungho License: MIT Version: 2.0.0

This directory contains auxiliary resources for the GitHub Analyzer skill.

Directory Structure

github-analyzer/
├── SKILL.md                    # Main skill definition
├── README.md                   # This file
├── assets/
│   └── architecture_note_template.md  # Template for generated notes
├── references/
│   ├── language_patterns.md    # File patterns by language
│   ├── design_patterns.md      # Common design patterns to detect
│   └── quality_metrics.md      # Code quality metrics guide
└── scripts/
    ├── analyze_structure.py     # Helper for code structure analysis
    ├── find_dependencies.py     # Dependency extraction helper
    └── calculate_metrics.py     # Code metrics calculator

How Claude Uses These Files

  1. SKILL.md: Loaded when skill is triggered, contains all instructions
  2. Template: Used as the starting point for generated Obsidian notes
  3. References: Consulted when specific language/pattern knowledge is needed
  4. Scripts: (Optional) Can be executed for repetitive, deterministic tasks

Security Notes

  • All scripts are read-only, never modify the analyzed repository
  • All operations must be confined to the temporary analysis directory
  • No code execution from the analyzed repository is permitted