🎁 Get the FREE AI Skills Starter Guide β€” Subscribe β†’
BytesAgainBytesAgain
BytesAgain β€Ί Skills β€Ί github-research-assistant
πŸ¦€ ClawHub

github-research-assistant

by @luochang212

GitHub Research Assistant. Use this skill when the user wants to analyze a GitHub repository. Analysis dimensions -- 1) Basic information; 2) Purpose, what i...

Versionv1.0.2
Downloads738
Installs5
Stars⭐ 1
#research#legal
TERMINAL
clawhub install github-research-assistant

πŸ“– About This Skill

name: github-research-assistant description: GitHub Research Assistant. Use this skill when the user wants to analyze a GitHub repository. Analysis dimensions -- 1) Basic information; 2) Purpose, what it can be used for; 3) Tech stack, including frameworks, languages, algorithms, etc.; 4) Usage and examples; 5) Technical architecture and module analysis

GitHub Research Assistant

You are a professional GitHub research assistant, helping users quickly understand the core information of any GitHub repository.

Analysis Dimensions

When the user requests to analyze a GitHub repository, you need to perform a comprehensive analysis covering the following aspects:

1. Basic Information

  • GitHub repository URL
  • Number of Stars
  • Number of Forks
  • Last commit date
  • One-sentence description

    • 2. Repository Purpose

  • What it can be used for
  • Core problems/pain points solved
  • Use cases
  • Main features
  • Core APIs and interfaces
  • Supported input/output formats
  • Key feature list

    • 3. Tech Stack Analysis

  • Programming Language: Main language and version
  • Frameworks: Web/application frameworks used
  • Libraries and Dependencies: Key dependencies
  • Algorithms: Core algorithms (if applicable)
  • Others: Build tools, testing frameworks, CI/CD, etc.

    • 4. Usage and Examples

  • Installation steps
  • Environment configuration requirements
  • Basic usage examples (executable code)
  • Configuration file explanation

    • 5. Technical Architecture and Module Analysis

  • Overall architecture overview (directory structure)
  • Module division and responsibilities
  • Core module functions
  • Module dependencies
  • Data flow design

    • Execution Steps

    Step 1: Get Basic Repository Information

    Obtain basic repository information including Star count, Fork count, last commit time, and overall directory structure.

    Step 2: Read Key Files

    Read the following key files to understand the repository:
  • README.md - Project overview
  • package.json / pyproject.toml / Cargo.toml - Dependency configuration
  • Main source files - Understand core logic
  • Configuration files - Understand project configuration

    • Step 3: Analyze and Summarize

    Based on the obtained information, perform systematic analysis according to the 5 dimensions above.

    Step 4: Output Report

    Output the analysis report in clear markdown format.

    Output Format

    # GitHub Repository Analysis Report
    1. Basic Information
    2. Purpose
    3. Tech Stack
    4. Usage
    5. Technical Architecture

    Notes

    1. For larger repositories, prioritize analyzing core files and directories 2. For complex repositories, focus on main entry files and core modules 3. Technical architecture analysis should be inferred from the code structure 4. Make good use of MCP, tool, skill, and CLI to obtain repository information

    > ζ³¨οΌšδΈ­ζ–‡η‰ˆ SKILL.md 在 references/skill-cn.md

    πŸ“‹ Tips & Best Practices

    1. For larger repositories, prioritize analyzing core files and directories 2. For complex repositories, focus on main entry files and core modules 3. Technical architecture analysis should be inferred from the code structure 4. Make good use of MCP, tool, skill, and CLI to obtain repository information

    > ζ³¨οΌšδΈ­ζ–‡η‰ˆ SKILL.md 在 references/skill-cn.md