docs: add LOCAL_CHANGES.md and update sync guide

This commit is contained in:
Max 2026-01-05 20:49:06 +08:00
parent 75873d35a8
commit ae6d2f4b6a
2 changed files with 41 additions and 0 deletions

36
LOCAL_CHANGES.md Normal file
View File

@ -0,0 +1,36 @@
# 本地定制变更记录 (Local Custom Changes Log)
此文件用于记录**本项目相对于官方 Upstream 代码的所有定制化修改**。
每次修改源码或资源时,**必须**在此更新,以便后续维护人员清楚知道我们改了什么。
---
## 1. 资源定制 (Resource Customizations)
我们替换了官方的默认图标/图片,以符合项目 UI 风格。
| 路径 (Path) | 说明 (Description) | 保护策略 (Protection) |
| :--- | :--- | :--- |
| `images/` | 整个目录被替换为私有设计资源 | **High**: 在 `sync_from_upstream.sh` 中被硬编码保护,合并时永远使用 Our Version。 |
## 2. UI/逻辑修改 (UI/Logic Modifications)
我们修改了部分源码以调整布局或逻辑。
### `lib/ui/widgets/video_screen.dart`
* **修改日期**: 2026-01-05
* **修改目的**: 统一视频播放页的按钮样式,使其与图片浏览页一致。
* **详细改动**:
* `IconButton` 被包裹在 48x48 的 `SizedBox` 中。
* `iconSize` 调整为 30。
* `Positioned` 底部距离从 `20` 调整为 `50`
* `Positioned` 左右距离从 `20` 调整为 `10`
---
## 3. 维护指南 (Maintenance Guide)
当您在 `upstream-main` (官方流) 之外修改了任何代码:
1. 请务必在此文件中新增记录。
2. 如果修改涉及**新文件**或**新目录**,请检查是否需要添加到 `scripts/sync_from_upstream.sh``PROTECTED_PATHS` 变量中。

View File

@ -24,8 +24,13 @@
* `images/` 下的定制资源。 * `images/` 下的定制资源。
* `UI Widgets` 的样式调整(如 `video_screen.dart` 的改动)。 * `UI Widgets` 的样式调整(如 `video_screen.dart` 的改动)。
### C. `LOCAL_CHANGES.md` (变更白皮书)
* **定义**: 项目的“差异账本”。
* **规则**: 任何不跟随官方的修改,**必须**在此文件记录。这能让我们在合并冲突时快速回忆起“这是我们故意改的”还是“意外”。
## 3. 同步工作流 (Synchronization Workflow) ## 3. 同步工作流 (Synchronization Workflow)
每当需要同步官方更新时执行以下标准流程Standard Operating Procedure 每当需要同步官方更新时执行以下标准流程Standard Operating Procedure
1. **更新基准**: 切换到 `upstream-main` 并拉取最新官方代码。 1. **更新基准**: 切换到 `upstream-main` 并拉取最新官方代码。