镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions CONTRIBUTING.ja-JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,21 +186,25 @@ Photo の差分、ベースライン不足、実行エラー、未完了の状
| 修正・調査が必要 | 指摘を読み、修正または根拠の提示を行います。 |
| ブロック中 | 次の対応を確認し、権限、サービス、タスク復旧の問題はメンテナーに連絡します。 |
| 承認待ち | メンテナーが現在のバージョンの 3 項目を確認し、Photo を手動で検査します。 |
| マージ待ち | 有効な承認が確認済みです。メンテナーが最終確認とマージを行います。 |
| マージ待ち | 3 項目の推奨判断が完了しています。Photo と利用可能な保存済み選択を確認し、リポジトリのルールに従って手動でマージします。 |
| 完了 | ワークフローの終了処理が完了しています。Photo の元の差分やエラーは残ります。 |
| 新バージョンに置換・未マージで終了 | 新しい結果を確認するか、未マージとして扱います。基準画像の更新を意味しません。 |

### コードを変更した後

新しいコミットや比較ベースラインの変更後は、バージョンを再確認し、必要なチェックを実行します。旧結果は履歴として残り、新しい変更の成功を証明しません。新しいコミットには、そのコミットに対する有効な承認が必要です。
新しいコミットや比較ベースラインの変更後は、バージョンを再確認し、必要なチェックを実行します。旧結果は履歴として残り、新しい変更の成功を証明しません。新しいコミットごとに結果と利用可能な Photo の保存済み選択を再確認してください。

### 承認とマージ

ワークフローは、リポジトリの Maintain または Admin 権限を持つメンテナーが現在のコミットに対して行った、有効な GitHub Approve を認識します。この承認は、BugServer Photo の結果を手動で確認したことも表します。
このワークフローでは GitHub Approve は監査記録として扱います。メンテナーは現在のコミットの CR、単体テスト、Playwright、Photo を確認したうえで手動で Merge できます。Approve はワークフロー上の必須条件ではありませんが、GitHub のブランチ保護やレビュー要件は引き続き適用されます。

Bot は自動で Approve や Merge を行いません。マージできるかどうかは GitHub のリポジトリルールにも従います。このワークフローは必須 Checks を追加したり、ブランチ保護を変更したりしません。

Photo の自動差分評価と基準画像の自動更新は停止中です。通常のマージ後に基準画像更新がスキップされるのは想定どおりです。Approve によって差分画像が自動採用されることはありません。先にマージしても、未完了や失敗のチェックが成功に変わることはありません。
Photo 選択が明示的に有効化された PR では、BugServer に現在の画像と短い説明が表示され、新しい候補は初期状態ですべて選択されます。各項目を確認し、基準画像を変更しない項目は選択を外して、マージ前に保存してください。サーバーに保存されたリビジョンが有効であり、未保存の編集は適用されません。保存済みの手動選択が初期選択で上書きされることはありません。

マージ後は、そのリビジョンで選択された基準画像だけを更新し、未選択項目は維持します。書き込み前に固定コミット、3 項目のチェック、実際のマージ内容、保存時刻、元の基準画像を検証します。古いバージョン、マージ後の保存、競合は自動で承認されません。タイムアウトや一部成功の場合はメンテナーが元のタスクを復旧し、別のバッチやリクエスト ID で重複実行しないでください。

Photo は引き続き report-only です。差分が 20 件を超える、説明が未完了、実行エラーがあるなどの理由で選択一覧が利用できない場合、マージ条件は追加せず、基準画像も自動更新しません。この機能が有効でない PR は既存の方式を維持します。基準画像の更新後も元の Photo レポートは書き換えず、completed は Photo の全件成功を意味しません。

### 問題が起きた場合

Expand Down
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,21 +186,23 @@ Photo differences, missing baselines, execution errors, and incomplete results r
| Changes or investigation needed | Read the findings, fix the issue, or provide evidence. |
| Blocked | Read the next action; contact maintainers for permissions, service issues, or task recovery. |
| Awaiting approval | Maintainers verify the three checks for the current version and manually inspect Photo. |
| Awaiting merge | A valid approval was recognized; maintainers perform final checks and merge. |
| Awaiting merge | The three checks are complete; inspect Photo and the saved selection, then merge manually. Approve is optional. |
| Completed | Workflow finalization is complete; original Photo differences and errors remain. |
| Superseded / closed without merge | Read the newer version, or treat the PR as unmerged. Neither status implies baseline updates. |

### After changing code

New commits or comparison-baseline changes cause the workflow to recheck the version and run the necessary checks. Older results remain historical evidence and cannot prove that a newer version passed. New commits need a valid approval for that commit.
New commits or comparison-baseline changes cause the workflow to recheck the version and run the necessary checks. Older results remain historical evidence and cannot prove that a newer version passed. Verify the results and saved selection for each new commit.

### Approval and merge

The workflow recognizes a valid GitHub Approve for the current commit from a maintainer with repository Maintain or Admin permission. This approval also represents the maintainer's manual verification of BugServer Photo results.
GitHub Approve is an audit record in this workflow. Maintainers may merge manually after checking CR, unit tests, Playwright and Photo for the current commit. GitHub branch protection and repository review requirements still apply. The Bot does not change those rules, approve, or merge.

The Bot does not automatically Approve or Merge. GitHub repository rules still govern merge availability; this workflow does not add required Checks or change branch protection.
For PRs explicitly enabled for Photo selection, BugServer shows the current images and short explanations. New candidates are selected by default. Inspect each item, deselect any baseline that should stay unchanged, and save successfully before merging. The server's saved revision is authoritative; an unsaved draft has no effect. Default selection does not overwrite a saved manual choice.

Automatic Photo difference assessment and baseline updates are paused. Skipping baseline updates after a normal merge is expected; Approve does not automatically adopt differing images. Merging early does not turn incomplete or failed checks into passes.
After merge, only the selected baselines in that revision are updated. Unselected items stay unchanged. Writes still verify the frozen commit, three checks, merged content, save time and original baseline. Stale versions, post-merge selections and conflicts are not silently accepted. Ask maintainers to resume the original task after a timeout or partial success; do not dispatch another batch or change request IDs.
Comment thread
Rui-Sun marked this conversation as resolved.
Resolved

Photo remains report-only. An unavailable selection list, including more than 20 differences, incomplete explanations or execution errors, adds no merge gate and does not update baselines. PRs without this capability retain their existing mode. Baseline updates do not rewrite the original Photo report, and completed does not mean Photo passed.

### Handling problems

Expand Down
18 changes: 13 additions & 5 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,12 @@ git push origin docs/add-funnel-demo

在 PR 中说明测试命令、结果、预期视觉变化和未完成项。无法运行的测试应写明原因;自比较只能验证稳定性,不能代替与官方基线的比较。

### 浏览器全量包的体积预算

`packages/vchart/.size-limit.json` 对 `build/index.min.js` 使用 **3 MB(3,000,000 字节)的未 gzip 压缩预算**,由独立 `size` CI 执行。2026-11-11 在 #4740 中,经维护者明确要求增大预算后重设:当时的 develop 基线与 PR 的运行源码、依赖锁文件及构建配置完全一致,原构建实测 2,433,648 字节,已超过旧 2 MB;模块检查未发现 ESM/CJS 重复打包。新预算保留 566,352 字节(约当前体积的 23%)余量,未删减公开 API、改用 gzip 计量或关闭检查。

这是对现有完整发行包的预算调整,不是包体优化,也不代表加载时间或运行性能改善。后续超过 3 MB 仍应失败;再次调整必须说明增长来源、实际构建体积及维护者接受的新预算,不能仅为让 CI 通过而修改阈值。该次预算验证见 [size CI](https://github.com/VisActor/VChart/actions/runs/43010617680)。

### 提交后检查哪些结果

查看 Bot 的代码审查 Review、GitHub 单测运行,以及 PR 中的工作流摘要。先核对摘要中的当前提交和比较基线,再判断结果是否适用于本次改动。
Expand All @@ -183,21 +189,23 @@ Photo 的差异、缺少基准、执行错误和未完成状态会如实保留
| 存在待修复或待调查项 | 阅读具体问题,修复或补充证据 |
| 流程受阻 | 查看待办;涉及权限、服务或任务恢复时联系维护者 |
| 等待人工批准 | 维护者核对当前版本的三项结果,并人工核查 Photo |
| 等待人工合入 | 已识别有效批准,由维护者完成最终检查和合入 |
| 等待人工合入 | 三项建议已完成,由维护者核查Photo与保存选择后手动合入;Approve可选 |
| 流程已完成 | 表示流程收尾完成,Photo 原有差异或错误仍保留 |
| 被新版本替代/未合入关闭 | 前者应查看新版本结果;后者不表示变更已合入或基准已更新 |

### 修改代码之后

推送新提交或比较基线变化后,工作流会重新核对版本并执行必要检查。旧版本结果保留为历史,不能直接作为新版本的通过依据;新提交需要对应的有效批准。
推送新提交或比较基线变化后,工作流会重新核对版本并执行必要检查。旧版本结果保留为历史,不能直接作为新版本的通过依据;新提交须重新核查当前版本的结果和已保存选择。

### 批准与合入

工作流识别具有仓库 Maintain 或 Admin 权限的维护者对当前提交作出的有效 GitHub Approve。该批准同时表示维护者已经人工核查 BugServer Photo 结果。
工作流中的 GitHub Approve 仅作审计;维护者核对当前提交的 CR、单测、Playwright 和 Photo 后,可以直接手动 Merge。GitHub 分支保护或仓库评审要求仍然适用,Bot 不会修改这些规则,也不会代为 Approve 或 Merge。

对已明确启用图文选择的 PR,BugServer 展示当前版本的图片和短说明,新候选默认全选。维护者应逐项核查;需要保留旧基准的项目取消选择,并在合入前保存成功。以服务端显示的保存修订为准,未保存草稿不生效;已保存的人工选择不会被默认全选覆盖。

Bot 不自动 Approve 或 Merge。是否能够点击 Merge 还受 GitHub 仓库规则约束;本工作流不会新增强制 Checks 或修改分支保护。
合入后只更新该修订已选的基准,未选项不变。写入前仍核对冻结提交、三项检查、实际合入内容、保存时间及原基准;旧版本、合入后补选或冲突不能自动补认。请求超时或部分成功时联系维护者按原任务恢复,不重新派发或更换请求 ID。

当前暂停 Photo 自动差异评估和标准图自动更新。正常合入后的“跳过标准图更新”属于预期行为;Approve 不会触发自动采用差异图。提前合入也不会使未完成或失败的检查自动变为通过。
Photo 始终 report-only。没有可用选择清单(例如差异超过20项、解释未完成或执行错误)不新增合入门禁,也不自动更新基准。未启用图文选择的 PR 保持原模式。基准更新不会改写原 Photo 报告,流程 completed 不等于 Photo 全部通过。

### 遇到异常

Expand Down
2 changes: 1 addition & 1 deletion packages/vchart/.size-limit.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
{
"path": "build/index.min.js",
"limit": "2 MB",
"limit": "3 MB",
Comment thread
Rui-Sun marked this conversation as resolved.
Resolved
"gzip": false
}
]
6 changes: 4 additions & 2 deletions packages/vchart/__tests__/visual/BUGSERVER_CASE_WORKFLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,13 @@ bugserver report get '<新case对应的报告ID>' --product VChart --json

CI/CR、Playwright 与 Photo 分别报告。当前 Photo 为 report-only:差异、缺基准、执行错误和未完成状态如实保留,不参与三项自动建议的阻断;工作流完成不等于 Photo 全部通过。新增 case 的脚本执行、请求或状态语义仍须结合相应断言验证,不能仅凭图片相似确认缺陷已修复。

## 6. 首次缺基准:人工核查、单独授权、重新验证
## 6. 首次缺基准:核查、选择或单独授权、重新验证

新 case 首次出现 `missing_baseline` 是尚无标准图的事实;先确认本轮执行成功、目标状态和测试图正确,再由维护者决定后续处理。缺图、执行异常、未完成或无法确认的测试图不能采用为基准。

**Approve/Merge 不授权自动采用测试图,工作流也不会在合入后自动建立或更新基准。** 由具有基准更新权限的项目管理员,在明确获得本次共享基准更新授权后,核对准确的产品、case/interaction、报告与 taskId,再通过平台或 CLI 采用已审阅的测试图:
对明确启用图文选择的 PR,先在 BugServer 核对当前冻结版本的图片、短说明及服务端保存修订;新候选默认全选,改选必须在合入前保存成功。维护者按仓库规则手动 Merge 后,工作流核验版本、三项建议、合入内容和原基准,只处理已选项,未选项不变。Approve 仅作审计,不代替图片核查;更新失败、部分成功或结果未知时联系维护者按原任务恢复,不另行手工重复写入。

未启用图文选择或没有可用清单时,Approve/Merge 本身不授权自动采用测试图,仍按以下人工流程处理。由具有基准更新权限的项目管理员另行获得本次共享基准更新授权,核对准确的产品、case/interaction、报告与 taskId,再通过平台或 CLI 采用已审阅的测试图:

```bash
# 仅有相应基准写权限且已获本次更新授权的项目管理员执行。
Expand Down
7 changes: 6 additions & 1 deletion packages/vchart/__tests__/visual/cases/manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"schemaVersion": 1,
"indexDigest": "995bd5e44ed4c9da70bff6efb3c1e9e2949964813b4ea2aac01d8e26a9345ae8",
"indexDigest": "1788ad6d5b37656fdaecdf02a609d8b4435819943706e1269bb03e78408e4200",
"ids": [
"title-resize-legend-layout",
"injected-stage",
"event-gesture-delay",
"event-subscription-ownership",
"event-throttle-propagation",
"linear-axis-update-bounds",
"band-axis-update-spec",
"legend-piecewise-domain",
Expand Down Expand Up @@ -238,6 +242,7 @@
"update-full-data-marker",
"pie-update-zero",
"dimension-index-area",
"dimension-index-leave",
"custom-mark-text-click",
"custom-mark-fill-click",
"datazoom-min-max-span",
Expand Down
Loading