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
83 changes: 0 additions & 83 deletions CONTRIBUTING.zh-CN.md

This file was deleted.

15 changes: 12 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!--
First of all, thank you for your contribution! 😄
For requesting to pull a new feature or bugfix, please send it from a feature/bugfix branch based on the `main` branch.
For requesting to pull a new feature or bugfix, please send it from a feature/bugfix branch based on the `develop` branch.
Before submitting your pull request, please make sure the checklist below is confirmed.
Your pull requests will be merged after one of the collaborators approve.
Thank you!
-->

[[中文版模板 / Chinese template](https://github.com/VisActor/vrender/blob/main/.github/PULL_REQUEST_TEMPLATE/pr_cn.md?plain=1)]
[中文版模板 / Chinese template](https://github.com/VisActor/VRender/blob/develop/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)

### 🤔 This is a ...

Expand Down Expand Up @@ -36,7 +36,7 @@ Thank you!

### 🐞 Bugserver case id

<!-- paste the `fileid` field in the bugserver case url -->
Only provide confirmed, public-safe case IDs. If unavailable, state that a product administrator must supply them. Only that product’s administrators may create cases; never use empty, placeholder or invented IDs. [Collaboration guide](https://github.com/VisActor/VRender/blob/develop/packages/vrender/__tests__/visual/BUGSERVER_CASE_WORKFLOW.md) (Chinese).

### 💡 Background and solution

Expand All @@ -59,6 +59,15 @@ Describe changes from the user side, and list all potential break changes or oth

### ☑️ Self-Check before Merge

Read [PR checks and merge process](https://github.com/VisActor/VRender/blob/develop/CONTRIBUTING.md#pr-checks-and-merge-process). Target `develop`; the advisory workflow accepts eligible same-repository, non-draft PRs created after 2026-11-06 17:05 Asia/Shanghai.

- [ ] Reported actual commands, outcomes, report scope and skipped checks/reasons.
- [ ] Ran relevant unit tests and full official-baseline comparison for product/dependency/case changes, or explained documentation-only applicability. Self-comparison is not a two-sided pass.
- [ ] Described expected visual changes and regression coverage; retained execution errors and blockers.

Photo needs maintainer review. Report-only/completed is not an all-Photo pass; approval is tied to the current commit and never automatically merges or updates baselines.


⚠️ Please check all items below before requesting a reviewing. ⚠️

- [ ] Doc is updated/provided or not needed
Expand Down
13 changes: 11 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE/pr_cn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
首先,感谢您参与代码贡献! 😄
为了提交新的功能或修改,请在主分支`main`分支上拉取开发分支 。
为了提交新的功能或修改,请在主分支`develop`分支上拉取开发分支 。
在提交PR 之前,请确认下面列到的一些内容
你的PR在核心成员review后,合并到主分支
谢谢!
Expand Down Expand Up @@ -33,7 +33,7 @@

### 🐞 Bugserver 用例 id

<!-- 将 bugserver case 上的 `fileid` 字段值黏贴过来 -->
仅填写已确认存在且可公开的真实caseId;无权限或未创建时注明“待项目管理员补充”。只有对应产品管理员可新增,禁止空值/占位/虚构ID。[协作流程](https://github.com/VisActor/VRender/blob/develop/packages/vrender/__tests__/visual/BUGSERVER_CASE_WORKFLOW.md)。

### 💡 问题的背景&解决方案

Expand All @@ -56,6 +56,15 @@

### ☑️ 自测

请阅读[PR检查与合入流程](https://github.com/VisActor/VRender/blob/develop/CONTRIBUTING.zh-CN.md#pr-检查与合入流程)。目标为develop;同仓且在2026-11-06 17:05北京时间起点后新建的非Draft PR可接入。

- [ ] 已填写实际测试命令、结果、报告范围和未运行项/原因。
- [ ] 产品/依赖/用例变更已完成相关单测及默认全量基线比较;纯文档说明不适用。自比较不能代替双侧通过。
- [ ] 已说明预期视觉变化及新增/修改的回归用例;执行错误和阻断如实保留。

Photo由维护者人工核查,report-only/流程完成不等于Photo全通过;批准绑定当前提交,不自动Merge或更新基准。


⚠️ 在提交 PR 之前,请检查一下内容. ⚠️

- [ ] 文档提供了,或者更新,或者不需要
Expand Down
19 changes: 14 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ VRender 是底层可视化渲染库,工程基准应优先服务“正确调用

面向 agent / 维护者的长期项目知识库入口在:

- [Agent 文档入口](/Users/bytedance/Documents/GitHub/VRender2/docs/agent/README.md)
- [Agent 文档入口](./docs/agent/README.md)

`docs/agent/` 用于快速了解当前代码结构、模块边界、owner 判断、运行时装配和验证入口。它不替代本文件的操作约束,也不承诺 public API;公开 API 仍以 package exports、README、用户文档和类型定义为准。

Expand All @@ -135,15 +135,15 @@ VRender 是底层可视化渲染库,工程基准应优先服务“正确调用

对 D3 状态引擎重构,统一入口在:

- [state-engine README](/Users/bytedance/Documents/GitHub/VRender2/docs/refactor/state-engine/README.md)
- [state-engine README](./docs/refactor/state-engine/README.md)

### 5.3 归档与后续项

如果需要快速了解 D3 项目整体结论、归档入口和保留问题,可查看:

- [D3 最终总结](/Users/bytedance/Documents/GitHub/VRender2/docs/refactor/state-engine/D3_FINAL_SUMMARY.md)
- [D3 归档索引](/Users/bytedance/Documents/GitHub/VRender2/docs/refactor/state-engine/D3_ARCHIVE_INDEX.md)
- [D3 后续项](/Users/bytedance/Documents/GitHub/VRender2/docs/refactor/state-engine/D3_FOLLOWUPS.md)
- [D3 最终总结](./docs/refactor/state-engine/D3_FINAL_SUMMARY.md)
- [D3 归档索引](./docs/refactor/state-engine/D3_ARCHIVE_INDEX.md)
- [D3 后续项](./docs/refactor/state-engine/D3_FOLLOWUPS.md)

这些文档是归档/导航材料,不是新的规范源。

Expand All @@ -156,3 +156,12 @@ VRender 是底层可视化渲染库,工程基准应优先服务“正确调用
- React 绑定层适配问题
- 提交前注意工作区里是否混有本地辅助文件;这类文件不应默认进仓。
- 如果需要给后续 agent 留长期有效的信息,应优先更新正式文档、README、归档索引或本文件,而不是重新引入“记忆文件”。

## 7. PR 工作流与视觉用例

- 提交前阅读[贡献指南](./CONTRIBUTING.zh-CN.md#pr-检查与合入流程),常规PR目标为develop;正式工作流仅接管符合起点的同仓新PR,稳定CR有独立范围。
- 产品、依赖或视觉用例变更先完成受影响包的单测/类型检查,再运行默认全量:`node packages/vrender/scripts/visual-test.mjs`。开发阶段可跑单例或目录;自比较仅验证稳定性,不能代替官方develop比较。纯文档检查链接、命令与实际状态,说明未运行测试即可。
- 新功能、缺陷修复和覆盖空缺补充确定性回归;按[用例指南](./packages/vrender/__tests__/visual/cases/README.md)登记,真实交互必须有业务断言。执行错误如实记录,不放宽阈值、跳过断言或替换基准。
- 平台Photo用例遵循[管理员协作流程](./packages/vrender/__tests__/visual/BUGSERVER_CASE_WORKFLOW.md),不编造caseId,不认为本地和平台自动同步。
- 处理Bot反馈先核对当前head/base和报告范围;Photo由维护者人工核查,report-only/流程完成不等于全部通过。不得自行Approve/Merge、编辑受管摘要/标记、自动更新基准或绕过未知请求去重。
- 结束时停止本轮启动的测试服务、浏览器及子进程,保留真实失败和未验证项。
Loading
Loading