Skip to content

README缺乏产物说明 — 用户运行 node index.js 如同黑箱 #322

@Bozhu12

Description

@Bozhu12

问题描述

运行 node index.js 后,用户无法感知:

  1. 产出在哪:日志文件、状态文件、gene/capsule 资源的位置和命名规则完全未说明
  2. 成功/失败判断:如何判断本次 run 是否产生了有意义的 mutation?无 mutation 时输出是什么?
  3. 可见性:没有 mutation 时,stdout 只有 GEP prompt,用户不知道是"没有可修的问题"还是"运行失败了"
  4. Wrapper 层缺失说明feishu-evolver-wrapper 提供了飞书汇报功能,但 README 完全未提及它的存在和用途

用户感受

官方说"三行上手,clone + install + node index.js",但跑完发现:

  • stdout 输出一段 GEP prompt(看不懂)
  • 不知道改了什么
  • 不知道下次怎么验证效果
  • 想看进度/历史记录但找不到入口

相当于一个工具跑完没有任何反馈,用户只能盲等。

建议改进

  1. README 增加"运行产物"章节,说明 logs/assets/gep/ 等目录内容和查看方式
  2. 增加"如何判断运行效果":什么是有 mutation,什么是无匹配(hub match only)
  3. 说明 logs/status_*.json 的作用和字段含义
  4. 说明 feishu-evolver-wrapper 的定位(不是必选项,但能提供可见性)

  • evolver v1.40.2
  • Node.js v24.14.0
  • Platform: linux x64

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions