oceanbase 向 oceanbase/oceanbase-design 提交 PR
适用场景
- 本地分支已推送到
origin，需要开 PR 到master（或指定 base）。 - 需要按仓库模板写 标题、描述、自检项，并可选为 PR 补打标签。
- Commit 后需在对话中输出用户可感知的更新日志。
前置条件
- 已安装并登录 GitHub CLI：
gh auth status成功。 - 远程为
github.com/oceanbase/oceanbase-design；当前工作目录为仓库根目录。 - 若刚做过
rebase/ 修改历史，需git push --force-with-lease origin <branch>后再开或更新 PR。
标题（Title）
- 使用英文、单行，与主要 commit 或变更范围一致。
- 格式与历史 PR 一致：
type(scope): short description（如chore(ci): …、fix(design): …、feat(ui): …）。 type常见：feat、fix、chore、docs、improve等；scope可为包名或区域（design、ui、root、ci）。
描述（Body）
- 打开并遵循仓库模板：
.github/PULL_REQUEST_TEMPLATE.md。 - 在正文中勾选与本次改动对应的项（Modified package、This is a...）。
- 填写 Background and solution、Changelog 的中英表格；无关联 issue 可写
N/A。 - 勾选 Self-Check before Merge 中已确认或明确不需要的项。
可将正文保存为临时文件后传给 gh（用完后删除临时文件，避免误提交）：
gh pr create --repo oceanbase/oceanbase-design --base master --head <你的分支名> \
--title "type(scope): English title here" \
--body-file path/to/body.md
仅查看现有 PR：
gh pr list --head <你的分支名> --base master
gh pr view <number> --web
Changelog
规则摘要见 .cursor/rules/changelog.mdc。核心：只写用户可感知的内容，实现细节写在 Background。
| ✅ 写 | ❌ 不写 |
|---|---|
| 组件 API / 行为 / 视觉变更 | 文件路径、index.figma.tsx 等实现布局 |
| 用户会遇到的 bug 修复 | CI、构建、lint、内部脚本 |
| 用户会采用的公开工具（CLI、MCP、Figma Code Connect） | Agent Skill、publish.sh 等内部流程 |
| 破坏性变更与迁移说明 | 无用户意义的数量清单（如「38 个组件」） |
无用户影响 → PR 填 No user-facing changes / 无用户可感知变更；commit 后不要编造更新日志，除非用户明确要求。
PR Changelog 表格
表格仍是中英两列；单元格内写 markdown 原文（与 docs/design/design-CHANGELOG.md / .zh-CN.md 同一套表述），不要用一句长段落概括。
版式规则
- 措辞：与官方 changelog 一致——按组件/区域分组、
emoji前缀、用户可感知的行为/视觉/API 变更；可带 PR 链接[#1234](url)。 - 换行：GitHub PR 表格单元格不支持多行 markdown，用
<br/>换行。 - 子项缩进：嵌套列表用
-前缀（两个 + 空格 +-），与 #1504 等历史 PR 一致。 - 语义：中英文条目一一对应，结构相同（同级组件、同级子项数量一致）。
单组件示例
| Language | Changelog |
| ---------- | --------------------------------- |
| 🇺🇸 English | - 💄 Updated Empty illustrations. |
| 🇨🇳 Chinese | - 💄 更新 Empty 插图。 |
| Language | Changelog |
| --- | --- |
| 🇺🇸 English | - Empty<br/> - 💄 Aligned illustration sizes (140px vertical, 160px horizontal), description color, and title/description/footer spacing with OBUI 2.0 spec.<br/> - 💄 Horizontal layout stacks vertically at container width ≤560px and hides illustration at ≤400px.<br/>- Result<br/> - 💄 Aligned icon size (140px) and title/subtitle/extra spacing with Empty OBUI 2.0 spec. |
| 🇨🇳 Chinese | - Empty<br/> - 💄 对齐 OBUI 2.0 规范的插图尺寸（纵向 140px、横向 160px）、描述文本颜色与标题/描述/操作区间距。<br/> - 💄 横向布局在容器宽度 ≤560px 时纵向堆叠，≤400px 时隐藏插图。<br/>- Result<br/> - 💄 对齐 OBUI 2.0 规范的图标尺寸（140px）以及与 Empty 一致的标题、副标题和操作区间距。 |
无用户影响 → 单元格填 No user-facing changes / 无用户可感知变更。
反例（过于内部）：
| 🇺🇸 English | Added 38 colocated index.figma.tsx files, Cursor agent skill, and CI parse/publish workflow. |
反例（表格里只写一句长文、未按 changelog 分组缩进）：
| 🇺🇸 English | 💄 Empty horizontal layout adapts to narrow containers; Empty and Result spacing align with OBUI 2.0 spec. |
Commit 后更新日志（对话）
有用户可感知变更时，在对话中按 docs/design/design-CHANGELOG.md 的版式输出（勿写入仓库文件）：
- <区域或组件>
- <emoji> <一行，用户视角>
或单行：
- 🤖 组件资产新增对应的 Figma 映射文件，通过 Figma Code Connect 可以打通设计+前端工作流，比如基于 Figma 生成符合规范的代码。
常用 emoji：🆕 新功能 · 🐞 修复 · 💄 样式 · 🌈 主题 · 📖 文档 · ⭐️ 增强 · ♿ 无障碍
正式发布时由发版负责人统一写入 docs/design/design-CHANGELOG.md / .zh-CN.md 及各包的 *CHANGELOG.md；日常 PR 与 commit 后不要改这些文件，除非用户明确要求做发版 changelog 整理。
自检：npm 包或 Figma 用户不看仓库能否感知？去掉文件名后是否仍然准确？中英文结构是否对齐？
打标签（可选）
合并后或创建后，CI 可能通过 PR Labeler（.github/labeler.yml、工作流为 pull_request_target）按变更路径自动加标签，同仓库分支与 fork 的 PR 均可；若需手动补打仓库已有标签：
gh pr edit <PR_NUMBER> --repo oceanbase/oceanbase-design \
--add-label "chore" \
--add-label "workflow"
注意：标签名须与 仓库已有 Labels 完全一致；无权限创建新标签时只加已有项。
可选建议标签（按改动类型选，非必须）
| 改动区域 | 可参考标签 |
|---|---|
根目录 / CI / .github |
chore, workflow, CI |
| 仅文档 / changelog | documentation, changelog |
| 某子包 | @oceanbase/design, @oceanbase/ui 等 |
与上一提交合并后推送
若需把多次提交压成一条再开 PR 或更新同一分支：
git reset --soft HEAD~<N> # N 为要合并的提交个数
git commit -m "type(scope): single final message"
git push --force-with-lease origin <branch>
无 gh 时的后备
在浏览器打开：https://github.com/oceanbase/oceanbase-design/compare/master...<分支名>?expand=1，将模板内容粘贴到描述框。
反模式
- 在仓库中长期保留
body.md等仅用于gh的临时文件；用毕应删除，勿加入版本控制。