Git Workflows

Git 工作流

Overview

概述

Git version control patterns, branching strategies, and team collaboration best practices.

Git版本控制模式、分支策略以及团队协作最佳实践。

Branching Strategies

分支策略

Git Flow

main ─────●────────────●─────────────●───────────
           \          /               \
            \   release/1.0          release/1.1
             \    /    \              /
develop ──────●───●──────●────●──────●────────────
               \        /      \    /
            feature/   feature/ feature/
            login      payment  search

bash

undefined

main ─────●────────────●─────────────●───────────
           \          /               \
            \   release/1.0          release/1.1
             \    /    \              /
develop ──────●───●──────●────●──────●────────────
               \        /      \    /
            feature/   feature/ feature/
            login      payment  search

bash

undefined

Initialize git flow

git flow init

Start a new feature

git flow feature start user-authentication

Work on feature...

git flow feature finish user-authentication

Start a release

git flow release start 1.0.0

Bug fixes only...

git flow release finish 1.0.0

Hotfix for production

git flow hotfix start critical-bug git flow hotfix finish critical-bug

undefined

git flow hotfix start critical-bug git flow hotfix finish critical-bug

undefined

GitHub Flow (Simplified)

GitHub Flow（简化版）

main ─────●──────●──────●──────●──────●───────
           \    /        \    /        \
         feature/       feature/      feature/
         add-auth       fix-bug       new-ui

bash

undefined

main ─────●──────●──────●──────●──────●───────
           \    /        \    /        \
         feature/       feature/      feature/
         add-auth       fix-bug       new-ui

bash

undefined

1. Create branch from main

git checkout main git pull origin main git checkout -b feature/add-authentication

2. Make changes and commit

git add . git commit -m "feat: add user authentication"

3. Push and create PR

git push -u origin feature/add-authentication gh pr create --title "Add user authentication" --body "..."

4. After review, merge via GitHub

gh pr merge --squash

5. Delete branch

git checkout main git pull origin main git branch -d feature/add-authentication

undefined

git checkout main git pull origin main git branch -d feature/add-authentication

undefined

Trunk-Based Development

基于主干的开发

main ────●──●──●──●──●──●──●──●──●────
         │     │        │
         └─────┴────────┴─── short-lived branches (< 1 day)

bash

undefined

main ────●──●──●──●──●──●──●──●──●────
         │     │        │
         └─────┴────────┴─── 短期分支（<1天）

bash

undefined

Small, frequent commits directly to main or via short-lived branches

小型、频繁的提交，直接提交到主干或通过短期分支

git checkout main git pull git checkout -b fix/typo-in-readme

Make small change...

进行小修改...

git commit -m "fix: typo in README" git push -u origin fix/typo-in-readme

PR, review, merge same day

当日完成PR、评审与合并

---

---

Common Operations

常用操作

Commits

提交

bash

undefined

bash

undefined

Stage specific changes

暂存特定更改

git add -p # Interactive staging

git add -p # 交互式暂存

Commit with message

附带信息提交

git commit -m "feat(auth): add JWT token validation"

Amend last commit (not pushed)

修改最后一次提交（未推送）

git commit --amend -m "feat(auth): add JWT token validation and refresh"

Commit with co-author

联合作者提交

git commit -m "feat: implement feature

Co-authored-by: Name email@example.com"

git commit -m "feat: implement feature

Co-authored-by: Name email@example.com"

Empty commit (trigger CI)

空提交（触发CI）

git commit --allow-empty -m "chore: trigger CI build"

undefined

git commit --allow-empty -m "chore: trigger CI build"

undefined

Conventional Commits

规范化提交格式

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Type	Description
feat	New feature
fix	Bug fix
docs	Documentation only
style	Formatting, no code change
refactor	Code change, no new feature or fix
perf	Performance improvement
test	Adding tests
chore	Build, CI, tooling

bash

undefined

<type>(<scope>): <description>

[可选正文]

[可选页脚]

类型	说明
feat	新功能
fix	Bug修复
docs	仅文档更新
style	格式调整，无代码逻辑变更
refactor	代码重构，无新功能或Bug修复
perf	性能优化
test	添加测试
chore	构建、CI、工具链相关

bash

undefined

Examples

示例

git commit -m "feat(api): add user registration endpoint" git commit -m "fix(auth): handle expired token refresh" git commit -m "docs: update API documentation" git commit -m "refactor(db): extract connection pool logic" git commit -m "test(user): add unit tests for validation"

undefined

git commit -m "feat(api): add user registration endpoint" git commit -m "fix(auth): handle expired token refresh" git commit -m "docs: update API documentation" git commit -m "refactor(db): extract connection pool logic" git commit -m "test(user): add unit tests for validation"

undefined

Branching

分支操作

bash

undefined

bash

undefined

Create and switch to branch

创建并切换到分支

git checkout -b feature/new-feature

or

或

git switch -c feature/new-feature

List branches

列出分支

git branch -a # All branches git branch -vv # With tracking info

git branch -a # 所有分支 git branch -vv # 包含跟踪信息

Delete branch

删除分支

git branch -d feature/merged-branch # Safe delete git branch -D feature/unmerged-branch # Force delete

git branch -d feature/merged-branch # 安全删除 git branch -D feature/unmerged-branch # 强制删除

Rename branch

重命名分支

git branch -m old-name new-name

Set upstream

设置上游分支

git branch --set-upstream-to=origin/main main

undefined

git branch --set-upstream-to=origin/main main

undefined

Merging

合并操作

bash

undefined

bash

undefined

Merge branch into current

将分支合并到当前分支

git merge feature/branch

Merge with no fast-forward (always create merge commit)

禁用快进合并（始终创建合并提交）

git merge --no-ff feature/branch

Squash merge (combine all commits)

squash合并（合并所有提交）

git merge --squash feature/branch git commit -m "feat: add feature (squashed)"

Abort merge

终止合并

git merge --abort

undefined

git merge --abort

undefined

Rebasing

变基操作

bash

undefined

bash

undefined

Rebase current branch onto main

将当前分支变基到主干

git fetch origin git rebase origin/main

Interactive rebase (last 3 commits)

交互式变基（最近3次提交）

git rebase -i HEAD~3

In editor, change 'pick' to:

在编辑器中，将'pick'改为：

- squash (s): combine with previous

- squash (s): 与前一次提交合并

- fixup (f): combine, discard message

- fixup (f): 合并并丢弃提交信息

- reword (r): change commit message

- reword (r): 修改提交信息

- edit (e): stop for amending

- edit (e): 暂停以修改提交

- drop (d): remove commit

- drop (d): 删除提交

Continue rebase after resolving conflicts

解决冲突后继续变基

git add . git rebase --continue

Abort rebase

终止变基

git rebase --abort

undefined

git rebase --abort

undefined

Stashing

暂存操作

bash

undefined

bash

undefined

Stash changes

暂存更改

git stash git stash push -m "work in progress"

Stash including untracked files

暂存包含未跟踪文件

git stash -u

List stashes

列出暂存记录

git stash list

Apply stash

应用暂存

git stash pop # Apply and remove git stash apply # Apply and keep git stash apply stash@{2} # Apply specific

git stash pop # 应用并删除暂存 git stash apply # 应用并保留暂存 git stash apply stash@{2} # 应用指定暂存

Show stash contents

查看暂存内容

git stash show -p stash@{0}

Drop stash

删除暂存

git stash drop stash@{0} git stash clear # Drop all

---

git stash drop stash@{0} git stash clear # 删除所有暂存

---

Undoing Changes

撤销更改

bash

undefined

bash

undefined

Discard changes in working directory

丢弃工作区的更改

git checkout -- file.txt git restore file.txt # Git 2.23+

Unstage file

取消暂存文件

git reset HEAD file.txt git restore --staged file.txt # Git 2.23+

Reset to previous commit (keep changes staged)

重置到上一次提交（保留更改在暂存区）

git reset --soft HEAD~1

Reset to previous commit (keep changes unstaged)

重置到上一次提交（保留更改在工作区）

git reset HEAD~~1 git reset --mixed HEAD~~1

Reset to previous commit (discard changes)

重置到上一次提交（丢弃所有更改）

git reset --hard HEAD~1

Revert a commit (create new commit that undoes)

撤销提交（创建新提交来抵消原提交）

git revert <commit-hash>

Revert merge commit

撤销合并提交

git revert -m 1 <merge-commit-hash>

---

git revert -m 1 <merge-commit-hash>

---

Git Hooks

Git 钩子

Pre-commit Hook

提交前钩子

bash

#!/bin/sh

bash

#!/bin/sh

.git/hooks/pre-commit

Run linting

运行代码检查

npm run lint if [ $? -ne 0 ]; then echo "Linting failed. Please fix errors before committing." exit 1 fi

npm run lint if [ $? -ne 0 ]; then echo "代码检查失败，请修复错误后再提交。" exit 1 fi

Run type checking

运行类型检查

npm run type-check if [ $? -ne 0 ]; then echo "Type checking failed. Please fix errors before committing." exit 1 fi

npm run type-check if [ $? -ne 0 ]; then echo "类型检查失败，请修复错误后再提交。" exit 1 fi

Check for console.log

检查是否存在console.log

if git diff --cached | grep -E '^+.*console.(log|debug|info)' > /dev/null; then echo "Warning: Found console.log statements. Remove before committing." exit 1 fi

undefined

if git diff --cached | grep -E '^+.*console.(log|debug|info)' > /dev/null; then echo "警告：发现console.log语句，请在提交前移除。" exit 1 fi

undefined

Husky + lint-staged

json

// package.json
{
  "scripts": {
    "prepare": "husky install"
  },
  "lint-staged": {
    "*.{js,ts,tsx}": [
      "eslint --fix",
      "prettier --write"
    ],
    "*.{json,md,yml}": [
      "prettier --write"
    ]
  }
}

bash

undefined

json

// package.json
{
  "scripts": {
    "prepare": "husky install"
  },
  "lint-staged": {
    "*.{js,ts,tsx}": [
      "eslint --fix",
      "prettier --write"
    ],
    "*.{json,md,yml}": [
      "prettier --write"
    ]
  }
}

bash

undefined

.husky/pre-commit

#!/bin/sh . "$(dirname "$0")/_/husky.sh"

npx lint-staged


```bash

#!/bin/sh . "$(dirname "$0")/_/husky.sh"

npx lint-staged


```bash

.husky/commit-msg

#!/bin/sh . "$(dirname "$0")/_/husky.sh"

npx --no -- commitlint --edit "$1"

---

#!/bin/sh . "$(dirname "$0")/_/husky.sh"

npx --no -- commitlint --edit "$1"

---

Advanced Operations

高级操作

Cherry-pick

拣选提交

bash

undefined

bash

undefined

Apply specific commit to current branch

将指定提交应用到当前分支

git cherry-pick <commit-hash>

Cherry-pick multiple commits

拣选多个提交

git cherry-pick <commit1> <commit2> <commit3>

Cherry-pick without committing

拣选提交但不自动提交

git cherry-pick -n <commit-hash>

Cherry-pick merge commit

拣选合并提交

git cherry-pick -m 1 <merge-commit-hash>

undefined

git cherry-pick -m 1 <merge-commit-hash>

undefined

Bisect (Find Bug Introduction)

二分查找（定位Bug引入点）

bash

undefined

bash

undefined

Start bisect

启动二分查找

git bisect start

Mark current as bad

标记当前提交为有问题

git bisect bad

Mark known good commit

标记已知正常的提交

git bisect good v1.0.0

Git checks out middle commit, test and mark

Git会检出中间提交，测试后标记

git bisect good # or git bisect bad

git bisect good # 或 git bisect bad

Repeat until found

重复直到找到问题提交

Git reports the first bad commit

Git会报告第一个有问题的提交

End bisect

结束二分查找

git bisect reset

Automated bisect

自动化二分查找

git bisect start HEAD v1.0.0 git bisect run npm test

undefined

git bisect start HEAD v1.0.0 git bisect run npm test

undefined

Worktrees

工作树

bash

undefined

bash

undefined

Create worktree for parallel work

创建工作树以并行开发

git worktree add ../project-hotfix hotfix/urgent-fix git worktree add ../project-feature feature/new-feature

List worktrees

列出工作树

git worktree list

Remove worktree

删除工作树

git worktree remove ../project-hotfix

undefined

git worktree remove ../project-hotfix

undefined

Submodules

子模块

bash

undefined

bash

undefined

Add submodule

添加子模块

git submodule add https://github.com/org/repo.git libs/repo

Clone with submodules

克隆包含子模块的项目

git clone --recurse-submodules https://github.com/org/project.git

Update submodules

更新子模块

git submodule update --init --recursive

Pull submodule updates

拉取子模块更新

git submodule update --remote

---

git submodule update --remote

---

Git Configuration

Git 配置

bash

undefined

bash

undefined

User config

用户配置

git config --global user.name "Your Name" git config --global user.email "you@example.com"

Default branch

默认分支

git config --global init.defaultBranch main

Editor

编辑器

git config --global core.editor "code --wait"

Aliases

别名

git config --global alias.co checkout git config --global alias.br branch git config --global alias.ci commit git config --global alias.st status git config --global alias.lg "log --oneline --graph --all" git config --global alias.unstage "reset HEAD --" git config --global alias.last "log -1 HEAD"

Pull behavior

拉取行为

git config --global pull.rebase true

Auto-setup remote tracking

自动设置远程跟踪

git config --global push.autoSetupRemote true

Credential caching

凭证缓存

git config --global credential.helper cache git config --global credential.helper 'cache --timeout=3600'

---

git config --global credential.helper cache git config --global credential.helper 'cache --timeout=3600'

---

git-workflows

Original

Translation

Git Workflows

Git 工作流

Overview

概述

Branching Strategies

分支策略

Git Flow

Git Flow

Initialize git flow

Initialize git flow

Start a new feature

Start a new feature

Work on feature...

Work on feature...

Start a release

Start a release

Bug fixes only...

Bug fixes only...

Hotfix for production

Hotfix for production

GitHub Flow (Simplified)

GitHub Flow（简化版）

1. Create branch from main

1. Create branch from main

2. Make changes and commit

2. Make changes and commit

3. Push and create PR

3. Push and create PR

4. After review, merge via GitHub

4. After review, merge via GitHub

5. Delete branch

5. Delete branch

Trunk-Based Development

基于主干的开发

Small, frequent commits directly to main or via short-lived branches

小型、频繁的提交，直接提交到主干或通过短期分支

Make small change...

进行小修改...

PR, review, merge same day

当日完成PR、评审与合并

Common Operations

常用操作

Commits

提交

Stage specific changes

暂存特定更改

Commit with message

附带信息提交

Amend last commit (not pushed)

修改最后一次提交（未推送）

Commit with co-author

联合作者提交

Empty commit (trigger CI)

空提交（触发CI）

Conventional Commits

规范化提交格式

Examples

示例

Branching

分支操作

Create and switch to branch

创建并切换到分支

or

或

List branches

列出分支

Delete branch

删除分支

Rename branch

重命名分支

Set upstream

设置上游分支

Merging

合并操作

Merge branch into current

将分支合并到当前分支

Merge with no fast-forward (always create merge commit)