docs: 重写 README 并补充界面截图与 MIT 许可证 #30

Merged
gitbobobo merged 1 commit from t3code/rewrite-readme-add-e2e-screenshots-mit-license into main 2026-10-01 19:43:01 +08:00
gitbobobo commented 2026-10-01 19:15:15 +08:00 (Migrated from github.com)

相关需求

无关联需求编号(文档与许可证维护)。

改动内容

  • 重写 README,补充产品定位、功能、技术栈、快速开始、配置、部署、项目结构和许可证说明。
  • 新增仪表盘、看板、问题列表、问题详情、版本、文档和日志界面截图。
  • 新增 MIT License 文件。

修改范围

  • README.md
  • LICENSE
  • docs/screenshots/

本地验收

  • 工作树环境配置完成
  • make lint 和 make test 通过
  • 应用可以启动
  • 主要使用流程已验证(server / web 按改动范围)
  • 异常或空状态已验证(如适用)

验证环境

  • 验证方式(命令 / 无头浏览器):make lint、make test,Playwright CLI(--channel chrome)无头截图
  • 启动命令:go build -o /tmp/fast_ship_server ./cmd/server && /tmp/fast_ship_server(server/ 目录);pnpm --dir web dev
  • 检查命令和结果:make lint 通过(gofmt / go vet / ESLint / tsc 均无告警);make test 通过(Go 全部包 ok,vitest 41 个测试文件 305 条用例全过);以 3 个项目、25 条 Issue、5 个版本的演示数据对仪表盘、看板、问题列表、问题详情、版本详情、文档、日志 7 个页面完成端到端截图
  • 验证提交 SHA:aced9d2

未验证范围与原因

GitHub 联动路径(真实仓库同步、发货到 GitHub Release)未验证:需要真实 GitHub 仓库与 Token,且本次改动仅涉及文档与静态资源,不影响相关代码路径。

API 变更说明

无。

审查意见处理

  • 逐条处理所有审查评论:Code Bot 两轮均为「未发现需处理的问题」;Codex 审查 ✅ Completed,无意见
  • 已分别顶层评论请求 @CodeBot review 与 @codex review,无上一轮未通过审查者需重请
  • 已按 $pr-review-loop 等待至收敛:所有审查者与 CI(Web Check)均已在 aced9d2 上回应

PR 描述修正

  • 补充需求编号(如果存在)
  • 变更影响范围已补充到 PR 描述中
## 相关需求 无关联需求编号(文档与许可证维护)。 ## 改动内容 - 重写 README,补充产品定位、功能、技术栈、快速开始、配置、部署、项目结构和许可证说明。 - 新增仪表盘、看板、问题列表、问题详情、版本、文档和日志界面截图。 - 新增 MIT License 文件。 ## 修改范围 - README.md - LICENSE - docs/screenshots/ ## 本地验收 - [x] 工作树环境配置完成 - [x] `make lint` 和 `make test` 通过 - [x] 应用可以启动 - [x] 主要使用流程已验证(server / web 按改动范围) - [x] 异常或空状态已验证(如适用) ## 验证环境 - 验证方式(命令 / 无头浏览器):`make lint`、`make test`,Playwright CLI(`--channel chrome`)无头截图 - 启动命令:`go build -o /tmp/fast_ship_server ./cmd/server && /tmp/fast_ship_server`(server/ 目录);`pnpm --dir web dev` - 检查命令和结果:`make lint` 通过(gofmt / go vet / ESLint / tsc 均无告警);`make test` 通过(Go 全部包 ok,vitest 41 个测试文件 305 条用例全过);以 3 个项目、25 条 Issue、5 个版本的演示数据对仪表盘、看板、问题列表、问题详情、版本详情、文档、日志 7 个页面完成端到端截图 - 验证提交 SHA:aced9d2 ## 未验证范围与原因 GitHub 联动路径(真实仓库同步、发货到 GitHub Release)未验证:需要真实 GitHub 仓库与 Token,且本次改动仅涉及文档与静态资源,不影响相关代码路径。 ## API 变更说明 无。 ## 审查意见处理 - [x] 逐条处理所有审查评论:Code Bot 两轮均为「未发现需处理的问题」;Codex 审查 ✅ Completed,无意见 - [x] 已分别顶层评论请求 `@CodeBot review` 与 `@codex review`,无上一轮未通过审查者需重请 - [x] 已按 `$pr-review-loop` 等待至收敛:所有审查者与 CI(Web Check)均已在 `aced9d2` 上回应 ## PR 描述修正 - [x] 补充需求编号(如果存在) - [x] 变更影响范围已补充到 PR 描述中
gitbobobo commented 2026-10-01 19:16:10 +08:00 (Migrated from github.com)

Code Bot 审查结论:

未发现需处理的问题。

(对照 server/configs/config.yaml、web/vite.config.ts、根 Dockerfile / Makefile 与 skills/fast-ship/SKILL.md:README 中的端口 4888/4999、配置项、部署示例与截图路径均一致;LICENSE 为标准 MIT;变更范围限于文档、许可证与静态截图,无运行时代码回归面。)

复审

如需复审,请单独在顶层评论回复 @CodeBot review

**Code Bot 审查结论:** 未发现需处理的问题。 (对照 `server/configs/config.yaml`、`web/vite.config.ts`、根 `Dockerfile` / `Makefile` 与 `skills/fast-ship/SKILL.md`:README 中的端口 4888/4999、配置项、部署示例与截图路径均一致;LICENSE 为标准 MIT;变更范围限于文档、许可证与静态截图,无运行时代码回归面。) <details> <summary>复审</summary> 如需复审,请单独在顶层评论回复 `@CodeBot review` </details>
gitbobobo commented 2026-10-01 19:31:45 +08:00 (Migrated from github.com)

@CodeBot review

@CodeBot review
gitbobobo commented 2026-10-01 19:31:47 +08:00 (Migrated from github.com)

@codex review

@codex review
chatgpt-codex-connector[bot] commented 2026-10-01 19:32:00 +08:00 (Migrated from github.com)

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-01T11:37:39.070440Z aced9d2 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

<!-- codex-pull-request-review-summary --> ## Codex Review Summary This comment shows the latest Codex review activity on this pull request. | Review | Status | Commit | Review trigger | | --- | --- | --- | --- | | 📝 **Code Review** | ✅ **Completed** <relative-time datetime="2026-10-01T11:37:39.070440Z">2026-10-01T11:37:39.070440Z</relative-time> | `aced9d2` | Manual request | <details> <summary>ℹ️ About Codex in GitHub</summary> <br/> [Your team has set up Codex to review pull requests in this repo](https://chatgpt.com/codex/cloud/settings/general). Reviews are triggered when you - Open a pull request for review - Mark a draft as ready - Comment "@codex review" or "@codex security review". Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. </details>
gitbobobo commented 2026-10-01 19:32:34 +08:00 (Migrated from github.com)

Code Bot 审查结论:

复审 HEAD aced9d2(相对先前结论无新提交)。先前 Fixed 0;仍 open 0;本轮无新 P0/P1/P2。

未发现需处理的问题。

(再次对照 server/configs/config.yaml、web/vite.config.ts、根 Dockerfile / Makefile、server/docker-compose.yml、.github/workflows/docker-publish.yml 与 skills/fast-ship/SKILL.md:README 端口 4888/4999、配置默认值、Docker/v* 发镜像与截图路径均一致;LICENSE 为标准 MIT;变更仍限于文档、许可证与静态截图。)

复审

如需复审,请单独在顶层评论回复 @CodeBot review

**Code Bot 审查结论:** 复审 HEAD `aced9d2`(相对先前结论无新提交)。先前 Fixed 0;仍 open 0;本轮无新 P0/P1/P2。 未发现需处理的问题。 (再次对照 `server/configs/config.yaml`、`web/vite.config.ts`、根 `Dockerfile` / `Makefile`、`server/docker-compose.yml`、`.github/workflows/docker-publish.yml` 与 `skills/fast-ship/SKILL.md`:README 端口 4888/4999、配置默认值、Docker/`v*` 发镜像与截图路径均一致;LICENSE 为标准 MIT;变更仍限于文档、许可证与静态截图。) <details> <summary>复审</summary> 如需复审,请单独在顶层评论回复 `@CodeBot review` </details>
chatgpt-codex-connector[bot] commented 2026-10-01 19:37:37 +08:00 (Migrated from github.com)

Codex Review: Didn't find any major issues. Swish!

Reviewed commit: aced9d2f6c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Codex Review: Didn't find any major issues. Swish! **Reviewed commit:** `aced9d2f6c` <details> <summary>ℹ️ About Codex in GitHub</summary> <br/> [Your team has set up Codex to review pull requests in this repo](https://chatgpt.com/codex/cloud/settings/general). Reviews are triggered when you - Open a pull request for review - Mark a draft as ready - Comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". </details>
Sign in to join this conversation.
No description provided.