# Git Workflow > Standardize Git workflow with conventional commits, PR templates, branch naming, and changelog generation. Use when committing code, creating PRs, managing releases, or when the user mentions git, commit, pull request, branch, or changelog. Use when this capability is needed. - Skill: `tomevault-io/git-workflow-188` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/git-workflow-188` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/git-workflow-188/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Productivity - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/git-workflow-188 --- # Git Workflow (Git 工作流) **Goal**: 规范化 Git 操作，确保提交历史清晰、可追溯、自动化友好。 --- ## 1. Conventional Commits ### 提交格式 ``` (): [optional body] [optional footer] ``` ### Type 类型 | Type | 说明 | 示例 | |------|------|------| | `feat` | 新功能 | feat(chat): add streaming response | | `fix` | 修复 Bug | fix(wallet): handle disconnect state | | `docs` | 文档更新 | docs(readme): update installation | | `style` | 代码格式 | style: format with prettier | | `refactor` | 重构 | refactor(api): extract service layer | | `perf` | 性能优化 | perf(query): add database index | | `test` | 测试 | test(auth): add unit tests | | `chore` | 构建/工具 | chore(deps): update dependencies | | `ci` | CI 配置 | ci: add github actions | ### Scope 范围 (项目特定) ``` AI 项目常用: - chat, prompt, model, stream, agent Web3 项目常用: - wallet, tx, contract, chain, sign 通用: - api, auth, db, ui, config ``` ### Subject 规则 - 使用祈使句 ("add" 而非 "added") - 首字母小写 - 不加句号 - 限制 50 字符 ### 示例 ```bash # 简单 feat(chat): add message history # 带 body fix(wallet): handle network switch during transaction The wallet would crash when user switches network while a transaction is pending. Now we cancel the pending tx and show an error message. # 带 breaking change feat(api)!: change response format to JSON:API BREAKING CHANGE: API responses now follow JSON:API spec. Old format is no longer supported. ``` --- ## 2. Branch Naming ### 格式 ``` /- ``` ### 示例 ```bash feat/PROJ-123-add-wallet-connect fix/PROJ-456-streaming-timeout refactor/no-ticket-cleanup-hooks hotfix/critical-security-patch ``` ### 分支策略 (Trunk-Based for OPC) ``` main (production) ↑ └── feat/xxx (short-lived feature branches) └── fix/xxx └── hotfix/xxx (直接合并 main) ``` **OPC 简化原则**: - 不需要 develop 分支 - Feature 分支尽快合并 (1-3 天) - Hotfix 直接从 main 创建并合并 --- ## 3. Pull Request Template ### 模板 (.github/pull_request_template.md) ```markdown ## Summary ## Changes - - - ## Type - [ ] feat: 新功能 - [ ] fix: Bug 修复 - [ ] refactor: 重构 - [ ] docs: 文档 - [ ] test: 测试 - [ ] chore: 其他 ## Testing - [ ] 本地测试通过 - [ ] 单元测试通过 - [ ] E2E 测试通过 (如适用) ## Screenshots ## Checklist - [ ] 代码已自审 - [ ] 无 console.log - [ ] 类型定义完整 - [ ] 文档已更新 (如需要) ``` ### PR 标题规范遵循 Conventional Commits 格式： ``` feat(chat): add streaming response support fix(wallet): handle disconnect state refactor(api): extract service layer ``` --- ## 4. Commit Message Templates ### Git 配置 ```bash # 设置提交模板 git config --global commit.template ~/.gitmessage # ~/.gitmessage # (): # # # #