dangaiden-project-overview

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Overview

项目概述

Produce a concise, human-readable summary of this project for someone new to the codebase.
为不熟悉代码库的人生成一份简洁易懂的项目摘要。

Steps

步骤

  1. Identity: Read
    README.md
    (if present) for the stated purpose. If absent, infer from directory names and key files.
  2. Structure: List top-level directories and files. Note the dominant language(s) and any obvious architecture layers (frontend, backend, infra, tests, docs).
  3. Recent activity: Run
    git log --oneline -10
    to show the last 10 commits. Summarize what areas have been changing.
  4. Open work: Look for
    TODO
    ,
    FIXME
    , or
    HACK
    comments with
    grep -r "TODO\|FIXME\|HACK" --include="*.md" .
    and note how many exist.
  5. Key entry points: Identify the main entrypoint files (e.g.
    main.*
    ,
    index.*
    ,
    app.*
    ,
    Makefile
    ,
    package.json
    ,
    Cargo.toml
    ).
If
$ARGUMENTS
is provided, focus the overview on that area or topic instead of the whole project.
  1. 项目定位:读取
    README.md
    (如果存在)了解项目声明的用途。如果不存在,则从目录名称和关键文件中推断。
  2. 项目结构:列出顶层目录和文件。标注主要使用的语言以及任何明显的架构层(前端、后端、基础设施、测试、文档)。
  3. 近期活动:运行
    git log --oneline -10
    查看最近10次提交。总结哪些领域有变更。
  4. 待完成工作:使用
    grep -r "TODO\|FIXME\|HACK" --include="*.md" .
    查找
    TODO
    FIXME
    HACK
    注释,并记录其数量。
  5. 关键入口文件:识别主要的入口文件(例如
    main.*
    index.*
    app.*
    Makefile
    package.json
    Cargo.toml
    )。
如果提供了
$ARGUMENTS
,则针对指定领域或主题生成概述,而非整个项目。

Output format

输出格式

  • Purpose: one sentence
  • Stack: languages, frameworks, key dependencies
  • Structure: bullet list of top-level dirs with one-line descriptions
  • Recent activity: what's been changing (based on git log)
  • Entry points: files to start reading
  • Open items: count of TODOs/FIXMEs, any that look urgent
Keep the output under 30 lines. Prioritize clarity over completeness.
  • 用途:一句话描述
  • 技术栈:语言、框架、关键依赖
  • 结构:顶层目录的项目符号列表,附单行描述
  • 近期活动:近期变更内容(基于Git日志)
  • 入口文件:开始阅读的文件
  • 待处理事项:TODO/FIXME的数量,以及任何看起来紧急的事项
输出内容控制在30行以内。优先保证清晰性而非完整性。