git-workflow-sop

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Git 工作流 SOP

Git Workflow SOP

概述

Overview

本 Skill 提供标准化的 Git 操作工作流，包括：

检查 git 状态并审查变更
生成合适的提交信息
使用规范的信息提交变更
与远程仓库同步
创建可复用的 SOP 文档

This Skill provides a standardized Git operation workflow, including:

Check git status and review changes
Generate appropriate commit messages
Commit changes using standardized messages
Synchronize with remote repositories
Create reusable SOP documents

使用场景

Usage Scenarios

当需要执行 Git 操作或记录标准工作流程时，调用此 Skill 以遵循最佳实践。

Invoke this Skill when you need to perform Git operations or record standard workflows to follow best practices.

操作步骤

Operation Steps

1. 检查 Git 状态

1. Check Git Status

首先，检查仓库的当前状态：

bash

git status

First, check the current status of the repository:

bash

git status

2. 审查变更

2. Review Changes

查看工作目录与上次提交之间的差异：

bash

git diff

View the differences between the working directory and the last commit:

bash

git diff

3. 暂存变更

3. Stage Changes

将所有变更添加到暂存区：

bash

git add .

Add all changes to the staging area:

bash

git add .

4. 生成提交信息

4. Generate Commit Message

创建描述性的提交信息，说明做了什么变更以及为什么：

bash

git commit -m "<描述性提交信息>"

提交信息最佳实践：

使用祈使句（"添加功能" 而不是 "添加了功能"）
第一行限制在 72 个字符以内
如需要，在正文中提供详细说明
如适用，引用相关的 issue 编号

提交信息类型前缀：

```
feat
```
: 新功能
```
fix
```
: 修复 bug
```
docs
```
: 文档更新
```
refactor
```
: 代码重构
```
test
```
: 测试相关
```
chore
```
: 构建/工具相关

Create a descriptive commit message explaining what changes were made and why:

bash

git commit -m "<descriptive commit message>"

Commit Message Best Practices:

Use imperative mood (e.g., "Add feature" instead of "Added feature")
Limit the first line to 72 characters
Provide detailed explanations in the body if needed
Reference relevant issue numbers if applicable

Commit Message Type Prefixes:

```
feat
```
: New feature
```
fix
```
: Bug fix
```
docs
```
: Documentation update
```
refactor
```
: Code refactoring
```
test
```
: Testing-related
```
chore
```
: Build/tool-related

5. 推送到远程仓库

5. Push to Remote Repository

将本地变更同步到远程仓库：

bash

git push origin <分支名>

Synchronize local changes to the remote repository:

bash

git push origin <branch-name>

6. 记录 SOP

6. Record SOP

创建文档，为后续参考和团队成员记录操作流程。

Create documents to record the operation process for future reference and team members.

示例

Examples

示例 1：标准提交工作流

Example 1: Standard Commit Workflow

常规变更：

bash

git status
git diff
git add .
git commit -m "docs: 更新文档并修复小问题"
git push origin main

Regular changes:

bash

git status
git diff
git add .
git commit -m "docs: update documentation and fix minor issues"
git push origin main

示例 2：功能开发

Example 2: Feature Development

带详细提交信息的功能开发：

bash

git status
git diff
git add .
git commit -m "feat: 实现用户认证功能

- 添加登录和注册接口
- 集成数据库进行用户存储
- 包含密码哈希以确保安全
- 添加 JWT 令牌生成用于会话管理"
git push origin feature/user-auth

Feature development with detailed commit message:

bash

git status
git diff
git add .
git commit -m "feat: implement user authentication feature

- Add login and registration interfaces
- Integrate database for user storage
- Include password hashing for security
- Add JWT token generation for session management"
git push origin feature/user-auth

示例 3：Bug 修复

Example 3: Bug Fix

bash

git status
git diff
git add .
git commit -m "fix: 修复 WebSocket 连接断开问题

- 添加心跳机制保持连接
- 增加重连逻辑
- 优化错误处理"
git push origin main

bash

git status
git diff
git add .
git commit -m "fix: resolve WebSocket disconnection issue

- Add heartbeat mechanism to maintain connection
- Increase reconnection logic
- Optimize error handling"
git push origin main

最佳实践

Best Practices

频繁提交：进行小而专注的提交，而不是大范围的变更
描述性信息：编写清晰的提交信息，说明"做了什么"和"为什么"
一致的工作流：每次提交都遵循相同的步骤以保持一致性
远程同步：定期推送变更以避免丢失工作
文档记录：保持 SOP 文档与当前实践同步更新

Frequent Commits: Make small, focused commits instead of large-scale changes
Descriptive Messages: Write clear commit messages explaining "what" and "why"
Consistent Workflow: Follow the same steps for each commit to maintain consistency
Remote Synchronization: Push changes regularly to avoid losing work
Documentation: Keep SOP documents updated with current practices

故障排除

Troubleshooting

问题：合并冲突

Issue: Merge Conflicts

如果遇到合并冲突：

拉取最新变更：
```
git pull origin main
```
在受影响的文件中手动解决冲突
暂存已解决的文件：
```
git add <已解决的文件>
```
完成合并：
```
git commit
```

If you encounter merge conflicts:

Pull the latest changes:
```
git pull origin main
```
Manually resolve conflicts in affected files
Stage resolved files:
```
git add <resolved-files>
```
Complete the merge:
```
git commit
```

问题：大文件

Issue: Large Files

如果 git 因大文件而变慢：

检查文件大小：

git ls-files | xargs ls -l | sort -k5 -n -r | head

考虑将大文件添加到
```
.gitignore
```
如需要，使用 Git LFS 处理大型二进制文件

If git slows down due to large files:

Check file sizes:

git ls-files | xargs ls -l | sort -k5 -n -r | head

Consider adding large files to
```
.gitignore
```
If necessary, use Git LFS to handle large binary files

问题：撤销操作

Issue: Undo Operations

撤销未暂存的修改：
```
git checkout -- <文件>
```
撤销已暂存的文件：
```
git reset HEAD <文件>
```
撤销最近一次提交（保留修改）：
```
git reset --soft HEAD~1
```

Undo unstaged changes:
```
git checkout -- <file>
```
Unstage staged files:
```
git reset HEAD <file>
```
Undo the last commit (keep changes):
```
git reset --soft HEAD~1
```

常用命令参考

Common Command Reference

命令	说明
`git log --oneline -10`	查看最近 10 条提交历史
`git diff --staged`	查看已暂存的变更
`git reset HEAD <文件>`	取消暂存文件
`git checkout -- <文件>`	丢弃工作目录中的变更
`git stash`	临时保存当前修改
`git stash pop`	恢复临时保存的修改
`git branch -a`	查看所有分支
`git remote -v`	查看远程仓库信息

Command	Description
`git log --oneline -10`	View the last 10 commit histories
`git diff --staged`	View staged changes
`git reset HEAD <file>`	Unstage files
`git checkout -- <file>`	Discard changes in the working directory
`git stash`	Temporarily save current changes
`git stash pop`	Restore temporarily saved changes
`git branch -a`	View all branches
`git remote -v`	View remote repository information