commit-workflow

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Complete workflow for creating commits following project standards.

遵循项目规范创建提交的完整工作流。

Use commit-creator agent
- Run
```
/commit-staged [context]
```
  for automated commit handling
- Or follow manual steps below
Analyze staged files only
- Check all staged files:
```
git diff --cached --name-only
```
- Read diffs:
```
git diff --cached
```
- Completely ignore unstaged changes
Commit message format
- First line:
```
{task-type}: brief description of the big picture change
```
- Task types:
```
feat
```
  ,
```
fix
```
  ,
```
refactor
```
  ,
```
docs
```
  ,
```
style
```
  ,
```
test
```
  ,
```
build
```
- Focus on 'why' and 'what', not implementation details
- For complex changes, add bullet points after blank line

Message examples

feat: implement user authentication system

fix: resolve memory leak in data processing pipeline

refactor: restructure API handlers to align with project architecture

Documentation update
- Check README.md for:
  - New features that should be documented
  - Outdated descriptions no longer matching implementation
  - Missing setup instructions for new dependencies
- Update as needed based on staged changes
Execution
- Commit uses HEREDOC syntax for proper formatting
- Verify commit message has correct format
- Don't add test plans to commit messages

使用commit-creator agent
- 运行
```
/commit-staged [context]
```
  进行自动化提交处理
- 或遵循以下手动步骤
仅分析暂存文件
- 查看所有暂存文件：
```
git diff --cached --name-only
```
- 查看差异内容：
```
git diff --cached
```
- 完全忽略未暂存的更改
Commit message 格式
- 第一行：
```
{task-type}: 对整体变更的简要描述
```
- 任务类型：
```
feat
```
  、
```
fix
```
  、
```
refactor
```
  、
```
docs
```
  、
```
style
```
  、
```
test
```
  、
```
build
```
- 重点描述「原因」和「内容」，而非实现细节
- 对于复杂变更，在空行后添加项目符号列表

信息示例

fix: 修复数据处理管道中的内存泄漏问题

refactor: 重构API处理器以符合项目架构