Skip to content

docs(readme): add development setup section#1948

Open
yejiming wants to merge 1 commit intoiOfficeAI:mainfrom
yejiming:jimmy/2026-03-30-12-45-01
Open

docs(readme): add development setup section#1948
yejiming wants to merge 1 commit intoiOfficeAI:mainfrom
yejiming:jimmy/2026-03-30-12-45-01

Conversation

@yejiming
Copy link
Copy Markdown
Contributor

Pull Request

Description

Add a new Development Setup section to readme.md so new contributors can build and run AionUi from source quickly.

This section includes:

  • Prerequisite badges for Node.js (>=22 <25) and Bun
  • Source setup commands (git clone, cd, bun install)
  • Development run command (bun run start)
  • Core quality checks (bun run test, bun run lint, bun run format:check)

Related Issues

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Testing

  • Tested on macOS
  • Tested on Windows
  • Tested on Linux
  • My code follows the project's code style guidelines
  • I have performed a self-review of my own code
  • My changes generate no new warnings or errors

Screenshots

Not applicable (documentation-only change).

Additional Context

This is a docs-only update and does not affect runtime behavior.

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@piorpua piorpua added the bot:reviewing Review in progress (mutex) label Mar 30, 2026
@piorpua
Copy link
Copy Markdown
Contributor

piorpua commented Mar 30, 2026

Code Review:docs(readme): add development setup section (#1948)

变更概述

PR 在 readme.md## 💬 Community & Support 之后、## License 之前,新增 ## 🛠️ Development Setup 章节,包含前置依赖(Node.js >=22 <25、Bun)、克隆安装步骤、开发启动命令及质量检查命令。这是纯文档变更,不影响运行时行为,对应 #1900


方案评估

结论:✅ 方案合理

内容准确——所有命令(bun installbun run startbun run testbun run lintbun run format:check)均与 package.json 脚本一致,Node.js 版本范围与 engines 字段完全匹配。章节结构清晰,能满足新贡献者快速上手的需求。


问题清单

🔵 LOW — 章节位置与贡献流程逻辑顺序相反

文件readme.md,第 617 行(新增 ## 🛠️ Development Setup

问题说明Development Setup 放在 Community & Support(含 ### Contributing)之后,而开发者需要先搭建环境才能按照 Contributing 流程提交 PR。从阅读流程来看,Development Setup 放在 ## 💬 Community & Support 之前或作为其前置章节更自然。

修复建议:将 ## 🛠️ Development Setup 整体移到 ## 💬 Community & Support 之前,或调整为 ## 💬 Community & Support 下的第一个子章节(位于 ### Contributing 之前)。


🔵 LOW — 质量检查命令未区分检查与自动修复

文件readme.md,第 644-646 行

问题代码

bun run lint
bun run format:check

问题说明:当前命令组合仅用于检查(lintformat:check),新贡献者看到报错后可能不知道有自动修复命令可用(lint:fixformat)。AGENTS.md 中开发阶段推荐先运行自动修复再检查。

修复建议

# Auto-fix lint and format
bun run lint:fix
bun run format

# Verify (read-only check)
bun run lint
bun run format:check

汇总

# 严重级别 文件 问题
1 🔵 LOW readme.md:617 章节位置与贡献流程逻辑顺序相反
2 🔵 LOW readme.md:644 质量检查命令未区分检查与自动修复

结论

批准合并 — 仅有两处 LOW 级文档建议,不构成阻塞,内容准确且命令均已验证。


本报告由本地 pr-review skill 生成,包含完整项目上下文,无截断限制。

CONCLUSION: APPROVED
IS_CRITICAL_PATH: true
PR_NUMBER: 1948

@piorpua
Copy link
Copy Markdown
Contributor

piorpua commented Mar 30, 2026

✅ 已自动 review,代码无阻塞性问题。

⚠️ 本 PR 涉及核心路径(readme.md),请人工确认后合并。

@piorpua piorpua added bot:ready-to-merge Bot done, code is clean — human just needs to confirm and merge and removed bot:reviewing Review in progress (mutex) labels Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:ready-to-merge Bot done, code is clean — human just needs to confirm and merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Add Development Setup section to README

2 participants