Generate a comprehensive natural language summary of a GitHub repository including maturity rating, code quality assessment, license info, and contributor pie chart.
Generates comprehensive GitHub repository summaries with maturity ratings, code quality assessment, and contributor analysis.
/plugin marketplace add jpoley/repo-summary/plugin install repo-summary@repo-summary-marketplaceGenerate comprehensive, natural language summaries of GitHub repositories with maturity ratings, code quality assessment, and contributor analysis.
$ARGUMENTS
IMPORTANT: Always save summaries to ./repo-summaries/ subfolder in the current working directory.
mkdir -p ./repo-summaries
Extract owner and repository name from the provided GitHub URL.
Supported formats:
https://github.com/owner/repohttps://github.com/owner/repo.gitgithub.com/owner/repoowner/repoURL="$ARGUMENTS"
CLEAN_URL=$(echo "$URL" | sed 's|https://github.com/||' | sed 's|github.com/||' | sed 's|\.git$||' | sed 's|/$||')
OWNER=$(echo "$CLEAN_URL" | cut -d'/' -f1)
REPO=$(echo "$CLEAN_URL" | cut -d'/' -f2)
Collect comprehensive data from multiple sources:
Use the GitHub MCP tools to fetch:
Repository search (mcp__github__search_repositories):
repo:owner/repoRecent commits (mcp__github__list_commits):
File structure (mcp__github__get_file_contents):
Open issues (mcp__github__list_issues):
Pull requests (mcp__github__list_pull_requests):
Fetch AI-generated documentation from DeepWiki:
WebFetch URL: https://deepwiki.com/{owner}/{repo}
Extract from DeepWiki:
Note: DeepWiki may not have indexed all repositories. If unavailable, proceed with GitHub data only.
Fetch additional code analysis from Google's CodeWiki:
WebFetch URL: https://codewiki.google/github.com/{owner}/{repo}
Extract from CodeWiki:
Note: CodeWiki requires the repository to have been previously scanned. If the page returns no useful content or shows an error, proceed without it and note "CodeWiki: Not indexed" in the references section.
Rate the project on a scale of 1-5 stars based on these criteria:
| Criterion | Points | Condition |
|---|---|---|
| Age | +1 | Created > 2 years ago |
| Contributors | +1 | More than 10 unique contributors |
| Commit Volume | +1 | More than 1,000 total commits |
| Releases | +1 | Has tagged releases |
| Recent Activity | +1 | Commits within last 6 months |
Rating Scale:
Evaluate code quality based on available signals:
| Signal | Assessment |
|---|---|
| Documentation | README quality, inline docs, wiki presence |
| Testing | Test files present (tests/, tests, _test., .spec.) |
| CI/CD | GitHub Actions, .travis.yml, Jenkinsfile presence |
| Code Organization | Clear directory structure, separation of concerns |
| Dependencies | Dependency management (package.json, requirements.txt, go.mod) |
| Security | SECURITY.md, security policy, vulnerability scanning |
Generate a qualitative assessment: Excellent / Good / Adequate / Needs Improvement
Process contributor data:
Contributor Distribution
========================
████████████████████ 45% | top-contributor (450 commits)
██████████ 25% | second-contributor (250 commits)
████████ 20% | third-contributor (200 commits)
██ 5% | fourth-contributor (50 commits)
█ 5% | others (50 commits)
Total: 1000 commits from 15 contributors
Write a comprehensive, paragraph-form summary following this structure:
# [Repository Name] - Repository Summary
[](https://github.com/owner/repo)
**Generated**: [Current Date]
**Source**: [GitHub URL]
---
## Overview
[2-3 paragraph natural language description of what the repository is, its purpose, and its significance in the ecosystem. Write in flowing prose, not bullet points.]
## Project Maturity
**Rating**: [★★★★☆] ([4/5])
[Natural language paragraph explaining the maturity assessment. Discuss the project's age, community size, development activity, and overall stability. Be specific about what contributes to the rating.]
## Code Quality Assessment
**Assessment**: [Excellent/Good/Adequate/Needs Improvement]
[Paragraph describing code quality signals observed. Discuss documentation, testing practices, CI/CD setup, and code organization. Provide specific examples where possible.]
## License
**Type**: [License Name] ([SPDX Identifier])
[Brief paragraph about what this license means for users. Is it permissive? Copyleft? What are the key obligations?]
## Architecture & Technical Insights
[If DeepWiki data available: Summarize key architectural patterns, main components, and technical design decisions. Write in natural language paragraphs.]
[If no DeepWiki data: Describe the repository structure based on file listing, identify main components, and note the technology stack based on files present.]
## Contributor Landscape
[ASCII PIE CHART HERE]
[Natural language paragraph analyzing the contributor distribution. Discuss the bus factor, whether contributions are well-distributed, and what this means for the project's sustainability. Highlight key contributors if notable.]
## Key Statistics
| Metric | Value |
|--------|-------|
| Stars | [count] |
| Forks | [count] |
| Open Issues | [count] |
| Contributors | [count] |
| Primary Language | [language] |
| Created | [date] |
| Last Updated | [date] |
## Quick Assessment
**Notable Features:**
- [Feature 1 observed in repository]
- [Feature 2 observed in repository]
- [Feature 3 observed in repository]
**Not Present:**
- [Standard element not found, e.g., "No test directory detected"]
- [Another missing element, if applicable]
**Best For:**
[One sentence describing the project's stated purpose based on README/description.]
---
## References
- **GitHub**: [https://github.com/owner/repo](https://github.com/owner/repo)
- **DeepWiki**: [https://deepwiki.com/owner/repo](https://deepwiki.com/owner/repo)
- **CodeWiki**: [https://codewiki.google/github.com/owner/repo](https://codewiki.google/github.com/owner/repo)
- **Documentation**: [Link if available]
---
*Summary generated by [repo-summary](https://github.com/jpoley/repo-summary) - A Claude Code Plugin*
Save the generated summary:
mkdir -p ./repo-summaries
FILENAME="${OWNER}-${REPO}.summary.md"
# Save content to ./repo-summaries/${FILENAME}
Report completion:
./repo-summaries/[owner]-[repo].summary.md| Issue | Solution |
|---|---|
| Repository not found | Verify URL and check if repo is public |
| DeepWiki unavailable | Proceed with GitHub data only, note in summary |
| CodeWiki not indexed | Proceed without CodeWiki, note "Not indexed" in references |
| Rate limiting | Inform user, suggest waiting |
| Private repository | Explain that full analysis requires public access |