code-summarizer

Solid

Generate concise summaries of source code at multiple scales. Use when users ask to summarize, explain, or understand code - whether it's a single function, a class, a module, or an entire codebase. Handles function-level code by explaining intention and core logic, and large codebases by providing high-level overviews with drill-down capabilities for specific modules.

AI & Automation 160 stars 17 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 87/100

Stars 20%
73
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Code Summarizer Generate clear, concise summaries of source code at any scale - from individual functions to entire codebases. ## Overview This skill helps analyze and summarize code by adapting the level of detail to the code's scale: - **Small-scale code** (functions, classes, small files): Provide focused summaries of intention and implementation - **Large-scale code** (modules, packages, entire repositories): Provide hierarchical summaries with progressive drill-down ## Workflow Decision Tree ``` User provides code → Assess scale ├─ Small-scale (< 200 lines, single file/function) │ └─ Generate focused summary │ └─ Large-scale (> 200 lines, multiple files/modules) ├─ Generate high-level overview ├─ List main modules/components └─ Prompt user to select specific parts for detailed analysis ``` ## Small-Scale Code Summarization For functions, classes, or small files (typically < 200 lines), provide a **focused summary** that includes: ### Summary Structure 1. **Purpose Statement** (1-2 sentences) - What does this code do? - What problem does it solve? 2. **Core Logic** (2-4 bullet points) - Key algorithms or approaches used - Important data transformations - Critical control flow decisions 3. **Key Details** - Input parameters and their purposes - Return values and their meaning - Important side effects or state changes - Dependencies on external libraries or modules 4. **Notable Patterns** (i...

Details

Author
ArabelaTso
Repository
ArabelaTso/Skills-4-SE
Created
6 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category