跳至内容

贡献指南

贡献代码

动手之前

  • 每个 Pull Request 只聚焦于单个功能或修复。
  • 避免不必要的格式改动,或与本次改动无关的大段编辑。
  • 在 PR 描述中说明你改了什么、为什么这么改。

基础 Git 工作流

1. Fork 本仓库

打开 WinUtil CN 仓库,点击右上角的 Fork 按钮。中文版的翻译与功能改进请提交到本仓库。

{650A4723-F38A-44A4-9820-D232BC87C8A0}

2. 克隆你的 Fork

git clone https://github.com/YOUR_USERNAME/winutil-cn.git
cd winutil-cn

3. 创建分支

永远不要直接在 main 分支上工作。

创建一个与你的改动相关的分支:

git checkout -b feature-name

示例:

git checkout -b add-firefox-tweak

4. 修改代码

用你顺手的文本编辑器打开项目,进行修改。

改动要小而聚焦。


5. 测试你的改动

使用 PowerShell 7(pwsh)构建中文版。仅构建和隔离测试无需启动应用或修改系统。

进入项目文件夹:

cd path\to\winutil-cn

运行:

pwsh -File 汉化\run-all.ps1
pwsh -File tools\Test-Build.ps1
powershell -NoProfile -File tools\Test-Build.ps1

功能变更需按影响运行回归测试(Pester 5.7.1),参见 tools/Invoke-Tests.ps1。界面与行为变更还应在合适的测试环境中确认:

  • WinUtil 能正常启动
  • 你的功能能正常工作
  • 没有弄坏其他东西

如果哪里出错,先修好再提交。


6. 检查你的改动

看看改了哪些内容:

git status

查看差异:

git diff

确认你没有不小心改到无关的文件。


7. 提交你的改动

暂存文件:

git add .

提交:

git commit -m "Add feature description"

示例:

git commit -m "Add Firefox package tweak"

8. 推送你的分支

git push origin branch-name

示例:

git push origin add-firefox-tweak

9. 发起 Pull Request

打开 GitHub 上你的 Fork。

GitHub 会显示一个创建 Pull Request 的按钮。 {C8C6A3CC-79D4-44FD-A54C-4C5717F12730}

提交之前:

  • 说明你改了什么
  • 说明你为什么改
  • 确认没有把无关文件一起提交进来

提交之后,维护者会审阅你的 PR。