docs/zh/development/git-workflow.md

Git 工作流

---

开发工作流

1. 创建功能分支

   git checkout -b feature/your-feature-name
   

2. 进行更改并测试

   • 编写代码
   • 添加测试
   • 运行测试确保通过
   • 运行 linter 检查代码质量

3. 提交更改

   git add .
   git commit -m "feat: your feature description"
   

4. 推送并创建 Pull Request

   git push origin feature/your-feature-name
   

提交前检查（prek）

仓库内已包含 .pre-commit-config.yaml。prek 可以作为 pre-commit 的 drop-in 替代品使用。

安装 prek

• macOS/Linux（Homebrew）

  brew install prek
  

• Python（uv）

  uv tool install prek
  

也可以不安装直接运行一次：

uvx prek --version

• Python（pipx）

  pipx install prek
  

• Node.js（pnpm）

  pnpm add -D @j178/prek
  

• Standalone installer（Linux/macOS）

  curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prek/releases/latest/download/prek-installer.sh | sh
  

如果使用 standalone installer，建议从 GitHub Releases 的最新版本页面复制安装脚本链接。

如果你已经在该仓库使用过 pre-commit：

• 将脚本/文档中的 pre-commit 命令替换为 prek
• 执行一次 prek install -f 重新安装 hooks

手动运行 hooks

prek run

对整个仓库运行所有 hooks：

prek run --all-files

安装 git hooks

prek install

如果你以前执行过 pre-commit install，建议重新安装一次：

prek install -f

卸载：

prek uninstall

如果通过 standalone installer 安装，prek 可以自更新：

prek self update

提交规范

我们使用 Conventional Commits 规范：

• feat: 新功能
• fix: 错误修复
• docs: 文档更改
• style: 代码格式更改
• refactor: 代码重构
• test: 测试相关
• chore: 构建过程或辅助工具的变动