Skip to content

foryourhealth111-pixel/Vibe-Skills / bundled/skills/commit-with-reflection

commit-with-reflection

Verified

Git提交与调试反思报告生成技能。用于分析开发过程中的错误、调试步骤和解决方案,生成结构化的中文反思报告,并创建包含报告引用的Git提交。显式请求词:反思提交、智能提交、生成调试报告、commit with reflection。

FileKindSize
README.mdmarkdown5.1 KB
SKILL.mdskill md20.9 KB
assets/template-chinese.mdmarkdown1.4 KB
examples/feature-example.mdmarkdown19.9 KB
references/best-practices.mdmarkdown18.1 KB
references/error-taxonomy.mdmarkdown12.4 KB
references/index.mdmarkdown2.9 KB
scripts/update-index.jsscript11.0 KB
# Commit with Reflection - Git提交与反思报告技能

自动化Git提交并生成深度调试反思报告的Claude技能。将AI编码过程中的错误、调试经验和解决方案转化为结构化的知识文档。

## 快速开始

### 1. 触发技能

在Claude Code中使用以下任一触发词:

```
反思提交
智能提交
生成调试报告
commit with reflection
```

### 2. 技能会自动

1. **检测错误**: 分析会话历史,识别错误和调试过程
2. **生成报告**: 创建包含10个章节的完整反思报告
3. **提交代码**: 创建Git提交并引用报告
4. **更新索引**: 自动更新报告索引文件

### 3. 报告存储位置

```
your-project/
└── docs/
    └── reflections/
        ├── INDEX.md                    # 主索引
        ├── 2026-02/
        │   ├── 15_feature_user-auth.md
        │   └── 14_bugfix_cors-issue.md
        └── 2026-01/
            └── ...
```

## 功能特性

### ✅ 自动错误检测
- 从会话历史提取错误消息
- 识别调试迭代过程
- 统计错误数量和类型

### ✅ 深度根本原因分析
- 使用"5个为什么"技术
- 区分直接原因、深层原因和促成因素
- 分析思维过程和假设

### ✅ 可执行的预防策略
- 具体的操作步骤
- 工具和命令示例
- 检查清单

### ✅ 知识提炼
- 识别可复用模式
- 标记应避免的反模式
- 生成类似任务检查清单

### ✅ 完整的测试记录
- 测试用例和结果
- 验证步骤
- 代码覆盖率

### ✅ 量化指标
- 错误统计
- 调试效率
- 代码变动
- 效率分析

## 报告结构

每份反思报告包含10个章节:

1. **概述** - 简要说明修改内容
2. **修改内容** - 详细列出所有变更
3. **遇到的错误** - 记录每个错误及解决方案
4. **根本原因分析** - 深入分析错误本质
5. **调试过程** - 完整的调试步骤和迭代
6. **经验总结** - 核心洞察和预防策略
7. **知识提炼** - 可复用模式和反模式
8. **测试与验证** - 测试用例和验证步骤
9. **参考资料** - 相关链接和文档
10. **指标** - 量化的统计数据

## 使用示例

### 示例 1: 功能开发

```
用户: "反思提交"

技能执行:
1. 检测到3个TypeScript类型错误
2. 生成完整反思报告
3. 创建Git提交:
   "feat: 实现用户认证功能

   遇到错误: 3
   调试迭代: 5

   详见反思报告: docs/reflections/2026-02/15_feature_user-auth.md

   Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>"
4. 更新索引文件
```

### 示例 2: 简单修改(无错误)

```
用户: "提交代码"

技能执行:
1. 检测到无错误发生
2. 询问: "未检测到错误,是否仍要生成反思报告?"
3. 用户选择"否"
4. 创建标准Git提交(无报告)
```

## 配置

### 环境要求

- Git仓库
- Node.js (用于索引更新脚本)
- 项目根目录有写权限

### 可选配置

在项目的 `.claude/settings.json` 中:

```json
{
  "skills": {
    "commit-with-reflection": {
      "reportDir": "docs/reflections",
      "language": "zh-CN",
      "autoIndex": true,
      "minErrorsForReport": 1
    }
  }
}
```

## 文档

### 核心文档
- [SKILL.md](SKILL.md) - 完整技能文档
- [references/best-practices.md](references/best-practices.md) - 最佳实践指南
- [references/error-taxonomy.md](references/error-taxonomy.md) - 错误分类体系

### 示例
- [examples/feature-example.md](examples/feature-example.md) - 功能开发示例

### 工具
- [scripts/update-index.js](scripts/update-index.js) - 索引更新脚本

## 最佳实践

### 1. 及时记录
在调试过程中实时记录关键步骤,不要事后回忆。

### 2. 深入分析
使用"5个为什么"技术挖掘根本原因,不要满足于表面原因。

### 3. 具体策略
预防策略要具体可执行,提供检查清单而非泛泛而谈。

### 4. 定期回顾
每周回顾反思报告,识别模式和趋势。

### 5. 持续改进
根据反思报告更新开发流程和检查清单。

## 常见问题

### Q: 报告太长怎么办?
A: 概述和总结要简洁,使用代码片段而非完整文件,将详细技术细节放到参考资料。

### Q: 没有遇到错误还需要写报告吗?
A: 简单修改不需要。复杂功能可以写"开发总结"而非"反思报告",重点记录设计决策。

### Q: 如何处理重复出现的错误?
A: 在报告中引用之前的相关报告,分析为什么预防策略没有生效,更新策略使其更具体。

### Q: 报告写给谁看?
A: 首先是写给未来的自己,其次是团队成员,也可以是新人培训材料。

## 技术支持

### 问题反馈
如果遇到问题或有改进建议:
1. 检查 [SKILL.md](SKILL.md) 中的"故障排除"章节
2. 查看 [references/best-practices.md](references/best-practices.md) 中的常见问题
3. 在项目中创建Issue

### 贡献
欢迎贡献改进:
1. Fork项目
2. 创建feature分支
3. 提交PR

## 版本历史

### v1.0 (2026-02-15)
- 初始版本
- 支持中文报告生成
- 自动错误检测
- Git提交集成
- 索引自动更新
- 支持feature/bugfix/refactor/docs四种类型

## 许可证

MIT License

---

**作者**: Claude Sonnet 4.5
**最后更新**: 2026-02-15
**版本**: v1.0
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall