Skip to content

docs: 三语 README + CI - #35

Merged
HenryYannis merged 2 commits into
mainfrom
docs/readme-i18n-ci
Oct 30, 2026
Merged

HenryYannis merged 2 commits into
mainfrom
docs/readme-i18n-ci

Conversation

@HenryYannis

Copy link
Copy Markdown
Owner

遇到的问题

  • README 中英混写,没有繁体版;仓库今天改名为 remove-officeplus,README 里的链接还是 Remove-OfficePlus。
  • 对照代码发现几处不准确:Quick-Remove.bat 写成"全自动清理",实际 PowerShell 脚本不带参数时会先扫描再询问 Y/N;覆盖范围表漏了 Software\Microsoft\OfficePLUS 和 HKCU 下的卸载键;参数表缺 --gui、--force;项目结构缺 winutil.py、gui_result_check.py、SECURITY.md。
  • CI 没有 ruff / pytest,actions/checkout、actions/setup-python 还停在 v4.4.0 / v5.6.0。

我的改动

README

  • 拆成 README.md(简体中文,默认)、README.zh-Hant.md(繁體中文)、README.en.md(English),三份结构一致,顶部有语言切换。
  • 结构:标题和一句话介绍 → 徽章(CI、Release、MIT)→ 能清理什么 → 下载与快速使用(exe / PowerShell / bat / Python)→ 安全:备份与恢复(含实测)→ 从源码构建(含项目结构、参与贡献)→ 常见问题 → 开源协议(含免责声明)。
  • 原有事实全部保留,按上面列的几处对照代码修正;所有仓库链接统一为 HenryYannis/remove-officeplus。
  • 协议行:中文版 MIT © 程小宝(沿用 LICENSE 里的署名),英文版 MIT © Henry Yannis。LICENSE 未改。

CI(ci.yml)

  • 新增 python-lint 任务(ubuntu):ruff check --select E9,F(语法错误、未定义名称、未使用的导入)、compileall、pytest tests。
  • checkout 升到 v7.0.1、setup-python 升到 v7.1.0,继续按 commit SHA 固定。原有的 PowerShell 检查、Python 3.8–3.12 矩阵、打包检查保持不变。
  • release.yml、e2e.yml 未改。

测试

  • 新增 tests/test_checks.py:用 pytest 跑 sync_rules.py --check、real_sample_check.py、gui_result_check.py(都不碰系统)。

怎么测试的

本地(Linux):ruff check --select E9,F . 通过,compileall 通过,pytest tests 3 passed。CI 结果见本 PR 的检查。

问题:README 中英混在一起,仓库改名后链接还是 Remove-OfficePlus;Quick-Remove.bat
写成“全自动清理”,实际会先扫描再询问确认;覆盖范围表漏了 Software\Microsoft\OfficePLUS;
CI 里没有 ruff/pytest,checkout/setup-python 还停在 v4/v5。

我的改动:
- README 拆成 README.md(简体)、README.zh-Hant.md(繁體)、README.en.md(English),结构一致,
  顶部语言切换;对照代码修正上述事实,链接统一为 HenryYannis/remove-officeplus。
- ci.yml 新增 ubuntu 上的 ruff(E9,F)、compileall、pytest;checkout 升到 v7.0.1、
  setup-python 升到 v7.1.0(按 SHA 固定)。release.yml、e2e.yml 未动。
- 新增 tests/test_checks.py,用 pytest 跑 sync_rules --check、real_sample_check、gui_result_check。

测试:本地 ruff check --select E9,F、compileall、pytest 3 passed。
@HenryYannis
HenryYannis marked this pull request as ready for review October 30, 2026 10:52
@HenryYannis
HenryYannis merged commit d12b33a into main Oct 30, 2026
11 checks passed
@HenryYannis
HenryYannis deleted the docs/readme-i18n-ci branch October 30, 2026 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant